🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

cloogle-js

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cloogle-js

TypeScript client for Cloogle

1.0.2
latest
npm
Version published
Maintainers
1
Created
Source

cloogle-js

TypeScript library for querying the Clean language search engine, Cloogle.

The types definition for the API are derived automatically from the one defined in Clean by Cloogle.

To install use npm i cloogle-js

Table of contents

Namespaces

  • types
  • validation

Functions

Functions

cloogle_url_of_BasicResult

cloogle_url_of_BasicResult(res: BasicResult): object

Parameters:

NameTypeDescription
resBasicResulta BasicResult object

Returns: object

NameType
dclURL
iclURL

returns URLs to view in cloogle res's _i_mplementation (icl) or _d_eclaration (dcl)

Defined in: main.ts:114

modulepath_of_filename

Constmodulepath_of_filename(filename: string): string

Parameters:

NameTypeDescription
filenamestringa Clean filename

Returns: string

returns it's module path

Defined in: main.ts:107

query

query(req: Request): Promise<Either<Errors, Response>>

Parameters:

NameType
reqRequest

Returns: Promise<Either<Errors, Response>>

returns either a validation error, or a Response from Cloogle

Defined in: main.ts:99

query_no_validation

query_no_validation(req: Request): Promise<any>

Parameters:

NameType
reqRequest

Returns: Promise<any>

returns Cloogle's unprocessed, unvalidated response

Defined in: main.ts:91

raw_query

raw_query(parameters: string): Promise<Either<Errors, Response>>

Parameters:

NameTypeDescription
parametersstringa string that represent the endpoint to be queried

Returns: Promise<Either<Errors, Response>>

returns either a validation error, or a Response from Cloogle

Defined in: main.ts:83

raw_query_no_validation

raw_query_no_validation(parameters: string): Promise<any>

Parameters:

NameTypeDescription
parametersstringa string that represent the endpoint to be queried

Returns: Promise<any>

returns Cloogle's unprocessed, unvalidated response

Defined in: main.ts:73

string_of_Result

string_of_Result(r: Result): string

Parameters:

NameTypeDescription
rResulta Cloogle result

Returns: string

a "short" string that sums up the information held by r

Defined in: main.ts:132

stringifyRequest

stringifyRequest(r: Request): string

Parameters:

NameType
rRequest

Returns: string

the endpoint to the Cloogle API for request

Defined in: main.ts:45

strings_of_Response

strings_of_Response(r: Response): string[]

Parameters:

NameTypeDescription
rResponsea Cloogle response

Returns: string[]

a list of "short" strings that sums up informations held in r.data

Defined in: main.ts:155

FAQs

Package last updated on 17 Jan 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts