Private
_baseThe base URL for the API
Settings for the API handler.
Static
Readonly
malformedCarries out a generic CKAN action. Should generally be avoided in favour of specific functions unless the action has not been implemented.
The API action to use.
Optional
data: TThe data to pass onto the API
Optional
method: AllowedMethods = "GET"The HTTP request method to use for this endpoint
Private
assertPrivate
Checks that implementations are not faulty, and detailed endpoints do, in fact, return details Must be used before returning a string array since there are 0 guarantees that responses are formatted correctly And according to my TypeScript definitions
the array that needs checking
Optional
expectedFields: string[]Private
assertPrivate
Checks that implementations are not faulty, and simplified endpoints are in fact simplified Must be used before returning a string array since there are 0 guarantees that responses are formatted correctly And according to my TypeScript definitions
the array that needs checking. Should be string[], but mis-implemented APIs can cause an error
Gets the autocomplete list for datasets (packages)
Optional
limit: numberGets the autocomplete list for groups
Optional
limit: numberGets the autocomplete list for organizations
Optional
limit: numberGets the autocomplete list for formats
Optional
limit: numberPrivate
convertPrivate
Converts one sort option to parameters that CKAN can handle
Private
convertPrivate
Converts the sort options to parameters that CKAN can handle
Optional
options: string | BaseSortOptions | BaseSortOptions[]Private
convertPrivate
Converts the user options to parameters that CKAN can handle
Gets the API's dataset (package) list.
Optional
settings: LimitOptionsGets the API's dataset (package) list with additional information.
Optional
settings: LimitOptionsGets the API's group list with details.
Optional
settings: GroupOptions = {}Gets the API's tag list with details.
Optional
settings: TagOptionsGets the API's detailed user list.
Optional
settings: UserOptions = {}Gets a group from the API
Optional
settings: SingleGroupOptionsGets the API's group list by only names.
Optional
settings: SortOptionsGets an organization from the API.
Optional
settings: SingleGroupOptionsGets the API's organizations list.
Optional
settings: SortOptionsSearches for a given dataset (package). Does not handle faceted search.
A solr query string
Optional
options: DatasetSearchOptionsSearches for a given resource.
A solr query string
Optional
options: SortOptionsPrivate
setGets the API's tag list.
Optional
settings: TagOptionsGets the API's user list.
Optional
settings: UserOptions = {}Gets the API's vocabulary list
Gets a single vocabulary from the API
Generated using TypeDoc
Implements the CKAN action API as per the latest documentation: https://docs.ckan.org/en/2.10/api/