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

• cloogle_url_of_BasicResult
• modulepath_of_filename
• query
• query_no_validation
• raw_query
• raw_query_no_validation
• string_of_Result
• stringifyRequest
• strings_of_Response

Functions

cloogle_url_of_BasicResult

▸ cloogle_url_of_BasicResult(res: BasicResult): object

Parameters:

Name | Type | Description | ------ | ------ | ------ | res | BasicResult | a BasicResult object |

Returns: object

Name | Type | ------ | ------ | dcl | URL | icl | URL |

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:

Name | Type | Description | ------ | ------ | ------ | filename | string | a Clean filename |

Returns: string

returns it's module path

Defined in: main.ts:107

query

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

Parameters:

Name | Type | ------ | ------ | req | Request |

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:

Name | Type | ------ | ------ | req | Request |

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:

Name | Type | Description | ------ | ------ | ------ | parameters | string | a 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:

Name | Type | Description | ------ | ------ | ------ | parameters | string | a 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:

Name | Type | Description | ------ | ------ | ------ | r | Result | a 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:

Name | Type | ------ | ------ | r | Request |

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:

Name | Type | Description | ------ | ------ | ------ | r | Response | a Cloogle response |

Returns: string[]

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

Defined in: main.ts:155