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
▸ cloogle_url_of_BasicResult(res: BasicResult): object
| 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
▸ Constmodulepath_of_filename(filename: string): string
| Name | Type | Description |
|---|---|---|
filename | string | a Clean filename |
Returns: string
returns it's module path
Defined in: main.ts:107
▸ query(req: Request): Promise<Either<Errors, Response>>
| 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(req: Request): Promise<any>
| Name | Type |
|---|---|
req | Request |
Returns: Promise<any>
returns Cloogle's unprocessed, unvalidated response
Defined in: main.ts:91
▸ raw_query(parameters: string): Promise<Either<Errors, Response>>
| 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(parameters: string): Promise<any>
| 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(r: Result): string
| 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(r: Request): string
| Name | Type |
|---|---|
r | Request |
Returns: string
the endpoint to the Cloogle API for request
Defined in: main.ts:45
▸ strings_of_Response(r: Response): string[]
| 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
FAQs
TypeScript client for Cloogle
We found that cloogle-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
