Optional config: Readonly<ClientConfig>The default configuration for this client instance.
The default configuration for this client instance.
Gets an author information via
GET /json/1.2/author/{key}.
The key of the author as used by CTAN.
Optional params: Readonly<json.v1_0.AuthorParameters>Parameters for getting an author.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
If params.ref is set to true,
the package list of the author
will be included in the response.
Gets a list of authors via
GET /json/1.2/authors.
Optional params: Readonly<json.v1_0.AuthorsParameters>Parameters for listing authors.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
If params.key is set,
only items with keys starting with the given string will be returned.
Lists licenses recognized by CTAN via
GET /json/1.2/licenses.
Optional params: Readonly<json.v1_1.LicensesParameters>Parameters for listing licenses.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
If params.key is set,
only items with keys starting with the given string will be returned.
Gets a list of packages via
GET /json/1.2/packages.
Optional params: Readonly<json.v1_0.PackagesParameters>Parameters for listing packages.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
If params.key is set,
only items with keys starting with the given string will be returned.
Gets a package information via
GET /json/1.2/pkg/{key}.
The key of the package as used by CTAN.
Optional params: Readonly<json.v1_0.PkgParameters>Parameters for getting a package.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
You can drop some of the fields
by using params.drop.
href field of
Package#documentation[]
is a URI string with ctan scheme,
representing the file path of documentation on CTAN, for example:ctan:/systems/texlive/Images/README.md
params['keep-url']
to true, you can get normal URLs like:http://mirrors.ctan.org/systems/texlive/Images/README.md
Finds items via GET /search/json.
Parameters for searching. If params is a string,
it specifies the search expression.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
Gets a topic information via
GET /json/1.2/topic/{key}.
The key of the topic as used by CTAN.
Optional params: Readonly<json.v1_0.TopicParameters>Parameters for getting a topic.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
If params.ref is set to true,
the package list of the topic
will be included in the response.
Gets a list of topics via
GET /json/1.2/topics.
Optional params: Readonly<json.v1_0.TopicsParameters>Parameters for listing topics.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
If params.key is set,
only items with keys starting with the given string will be returned.
Gets the CTAN JSON API version via
GET /json/1.2/version.
Optional config: Readonly<ClientConfig>An optional configuration for this request.
Generated using TypeDoc
Client for the CTAN JSON API v1.2.