Class Client

[src]
[src]

Hierarchy

ClientBase
Searchable
- Client

Index

Constructors

Accessors

defaults v1_0 v1_1 v1_2 v1_3 v2_0

Methods

Constructors

constructor

[src]

new Client(config?: Readonly<ClientConfig>): json.Client
Parameters
- Optional config: Readonly<ClientConfig>
  
  Default configuration for this client instance.
Returns json.Client
Overrides ClientBase.constructor

Accessors

defaults

[src]

get defaults(): ClientConfig
The default configuration for this client instance.

Returns ClientConfig
Inherited from ClientBase.defaults

v1_0

[src]

get v1_0(): json.v1_0.Client
Subclient for the CTAN JSON API v1.0.

Returns json.v1_0.Client

v1_1

[src]

get v1_1(): json.v1_1.Client
Subclient for the CTAN JSON API v1.1.

Returns json.v1_1.Client

v1_2

[src]

get v1_2(): json.v1_2.Client
Subclient for the CTAN JSON API v1.2.

Returns json.v1_2.Client

v1_3

[src]

get v1_3(): json.v1_3.Client
Subclient for the CTAN JSON API v1.3.

Returns json.v1_3.Client

v2_0

[src]

get v2_0(): json.v2_0.Client
Subclient for the CTAN JSON API v2.0.

Returns json.v2_0.Client

Methods

search

[src]

search(params: string | Readonly<SearchParameters>, config?: Readonly<ClientConfig>): Promise<SearchPaginator>
Finds items via GET /search/json.
Parameters
- params: string | Readonly<SearchParameters>
  
  Parameters for searching. If params is a string, it specifies the search expression.
- Optional config: Readonly<ClientConfig>
  
  An optional configuration for this request.
Returns Promise<SearchPaginator>

Generated using TypeDoc