Class default

Implements the CKAN action API as per the latest documentation: https://docs.ckan.org/en/2.10/api/

Hierarchy

default

Constructors

constructor

new default(baseUrl, options?): default
Parameters
- baseUrl: string
  
  The url for the CKAN API endpoint.
- Optional options: Settings = {}
  
  Base settings for CKAN
Returns default
- Defined in ckan.ts:67

Properties

`Private` _baseUrl

_baseUrl: string

The base URL for the API

options

options: Settings

Settings for the API handler.

`Static` `Readonly` malformedApiResponse

malformedApiResponse: "Malformed API response, cannot parse data." = "Malformed API response, cannot parse data."

Accessors

baseUrl

get baseUrl(): string
Returns string
- Defined in ckan.ts:86
set baseUrl(newUrl): void
Parameters
- newUrl: string
Returns void
- Defined in ckan.ts:89

Methods

action

action<T, U>(action, data?, method?): Promise<U>
Carries out a generic CKAN action. Should generally be avoided in favour of specific functions unless the action has not been implemented.
Type Parameters
- T
- U
Parameters
- action: string
  
  The API action to use.
- Optional data: T
  
  The data to pass onto the API
- Optional method: AllowedMethods = "GET"
  
  The HTTP request method to use for this endpoint
Returns Promise<U>
- Defined in ckan.ts:202

`Private` assertObjectArray

assertObjectArray<T>(check, expectedFields?): T
Private
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
Type Parameters
- T
Parameters
- check: T
  
  the array that needs checking
- Optional expectedFields: string[]
Returns T
- Defined in ckan.ts:180

`Private` assertStringArray

assertStringArray<T>(check): string[]
Private
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
Type Parameters
- T
Parameters
- check: T
  
  the array that needs checking. Should be string[], but mis-implemented APIs can cause an error
Returns string[]
- Defined in ckan.ts:164

autocompleteDataset

autocompleteDataset(query, limit?): Promise<AutocompleteDataset[]>
Gets the autocomplete list for datasets (packages)
Parameters
- query: string
- Optional limit: number
Returns Promise<AutocompleteDataset[]>
- Defined in ckan.ts:242

autocompleteFormat

autocompleteFormat(query, limit?): Promise<string[]>
Gets the autocomplete list for formats
Parameters
- query: string
- Optional limit: number
Returns Promise<string[]>
- Defined in ckan.ts:257

autocompleteGroup

autocompleteGroup(query, limit?): Promise<AutocompleteGroup[]>
Gets the autocomplete list for groups
Parameters
- query: string
- Optional limit: number
Returns Promise<AutocompleteGroup[]>
- Defined in ckan.ts:267

autocompleteOrganization

autocompleteOrganization(query, limit?): Promise<AutocompleteGroup[]>
Gets the autocomplete list for organizations
Parameters
- query: string
- Optional limit: number
Returns Promise<AutocompleteGroup[]>
- Defined in ckan.ts:277

autocompleteTag

autocompleteTag(query, limit?): Promise<string[]>
Gets the autocomplete list for tags
Parameters
- query: string
- Optional limit: number
Returns Promise<string[]>
- Defined in ckan.ts:287

autocompleteUser

autocompleteUser(query, limit?): Promise<AutocompleteUser[]>
Gets the autocomplete list for formats
Parameters
- query: string
- Optional limit: number
Returns Promise<AutocompleteUser[]>
- Defined in ckan.ts:297

available

available(): Promise<boolean>
Checks whether an API is accessible.

Returns Promise<boolean>
- Defined in ckan.ts:233

`Private` convertSingleSortOption

convertSingleSortOption(options): string
Private
Converts one sort option to parameters that CKAN can handle
Parameters
- options: string | BaseSortOptions
Returns string
- Defined in ckan.ts:132

`Private` convertSortOptions

convertSortOptions(options?): string
Private
Converts the sort options to parameters that CKAN can handle
Parameters
- Optional options: string | BaseSortOptions | BaseSortOptions[]
Returns string
- Defined in ckan.ts:147

`Private` convertUserOptions

convertUserOptions(options): {
    email: string;
    order_by: any;
    q: string;
}
Private
Converts the user options to parameters that CKAN can handle
Parameters
- options: UserOptions
Returns {
    email: string;
    order_by: any;
    q: string;
}
- email: string
- order_by: any
- q: string
- Defined in ckan.ts:114

dataset

dataset(id): Promise<Dataset>
Gets the details of a data set from the API.
Parameters
- id: string
Returns Promise<Dataset>
- Defined in ckan.ts:358

datasets

datasets(settings?): Promise<string[]>
Gets the API's dataset (package) list.
Parameters
- Optional settings: LimitOptions
Returns Promise<string[]>
- Defined in ckan.ts:367

detailedDatasets

detailedDatasets(settings?): Promise<Dataset[]>
Gets the API's dataset (package) list with additional information.
Parameters
- Optional settings: LimitOptions
Returns Promise<Dataset[]>
- Defined in ckan.ts:376

detailedGroups

detailedGroups(settings?): Promise<Group[]>
Gets the API's group list with details.
Parameters
- Optional settings: GroupOptions = {}
Returns Promise<Group[]>
- Defined in ckan.ts:420

detailedOrganizations

detailedOrganizations(settings?): Promise<Organization[]>
Parameters
- settings: GroupOptions = {}
Returns Promise<Organization[]>
- Defined in ckan.ts:480

detailedTags

detailedTags(settings?): Promise<Tag[]>
Gets the API's tag list with details.
Parameters
- Optional settings: TagOptions
Returns Promise<Tag[]>
- Defined in ckan.ts:519

detailedUsers

detailedUsers(settings?): Promise<User[]>
Gets the API's detailed user list.
Parameters
- Optional settings: UserOptions = {}
Returns Promise<User[]>
- Defined in ckan.ts:546

group

group(id, settings?): Promise<Group>
Gets a group from the API
Parameters
- id: string
- Optional settings: SingleGroupOptions
Returns Promise<Group>
- Defined in ckan.ts:389

groups

groups(settings?): Promise<string[]>
Gets the API's group list by only names.
Parameters
- Optional settings: SortOptions
Returns Promise<string[]>
- Defined in ckan.ts:410

licenses

licenses(): Promise<License[]>
Gets the API's license list.

Returns Promise<License[]>
- Defined in ckan.ts:440

organization

organization(id, settings?): Promise<Organization>
Gets an organization from the API.
Parameters
- id: string
- Optional settings: SingleGroupOptions
Returns Promise<Organization>
- Defined in ckan.ts:450

organizations

organizations(settings?): Promise<string[]>
Gets the API's organizations list.
Parameters
- Optional settings: SortOptions
Returns Promise<string[]>
- Defined in ckan.ts:470

resource

resource(id): Promise<Resource>
Gets the details of a resource from the API.
Parameters
- id: string
Returns Promise<Resource>
- Defined in ckan.ts:501

searchDataset

searchDataset(query, options?, raw?): Promise<Dataset[]>
Searches for a given dataset (package). Does not handle faceted search.
Parameters
- query: string
  
  A solr query string
- Optional options: DatasetSearchOptions
- raw: boolean = false
Returns Promise<Dataset[]>
- Defined in ckan.ts:307

searchDatasetRawResult

searchDatasetRawResult(query, options?): Promise<RawSearchResult<Dataset[]>>
Parameters
- query: string
- Optional options: DatasetSearchOptions
Returns Promise<RawSearchResult<Dataset[]>>
- Defined in ckan.ts:312

searchResource

searchResource(query, options?): Promise<Resource[]>
Searches for a given resource.
Parameters
- query: string
  
  A solr query string
- Optional options: SortOptions
Returns Promise<Resource[]>
- Defined in ckan.ts:344

`Private` setBaseUrl

setBaseUrl(baseUrl): void
Private
Changes the base url
Parameters
- baseUrl: string
  
  The url for the CKAN API endpoint.
Returns void
- Defined in ckan.ts:98

user

user(id): Promise<User>
Gets a user from the API.
Parameters
- id: string
Returns Promise<User>
- Defined in ckan.ts:528

users

users(settings?): Promise<string[]>
Gets the API's user list.
Parameters
- Optional settings: UserOptions = {}
Returns Promise<string[]>
- Defined in ckan.ts:537

vocabularies

vocabularies(): Promise<Vocabulary[]>
Gets the API's vocabulary list

Returns Promise<Vocabulary[]>
- Defined in ckan.ts:563

vocabulary

vocabulary(id): Promise<Vocabulary>
Gets a single vocabulary from the API
Parameters
- id: string
Returns Promise<Vocabulary>
- Defined in ckan.ts:555

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

baseUrl: string

Optional options: Settings = {}

Returns default

Properties

Private _baseUrl

options

Static Readonly malformedApiResponse

Accessors

baseUrl

Returns string

Parameters

newUrl: string

Returns void

Methods

action

Type Parameters

T

U

Parameters

action: string

Optional data: T

Optional method: AllowedMethods = "GET"

Returns Promise<U>

Private assertObjectArray

Type Parameters

T

Parameters

check: T

Optional expectedFields: string[]

Returns T

Private assertStringArray

Type Parameters

T

Parameters

check: T

Returns string[]

autocompleteDataset

Parameters

query: string

Optional limit: number

Returns Promise<AutocompleteDataset[]>

autocompleteFormat

Parameters

query: string

Optional limit: number

Returns Promise<string[]>

autocompleteGroup

Parameters

query: string

Optional limit: number

Returns Promise<AutocompleteGroup[]>

autocompleteOrganization

Parameters

query: string

Optional limit: number

Returns Promise<AutocompleteGroup[]>

autocompleteTag

Parameters

query: string

Optional limit: number

Returns Promise<string[]>

autocompleteUser

Parameters

query: string

Optional limit: number

Returns Promise<AutocompleteUser[]>

available

Returns Promise<boolean>

Private convertSingleSortOption

Parameters

`Optional` options: Settings = {}

`Private` _baseUrl

`Static` `Readonly` malformedApiResponse

`Optional` data: T

`Optional` method: AllowedMethods = "GET"

`Private` assertObjectArray

`Optional` expectedFields: string[]

`Private` assertStringArray

`Optional` limit: number

`Optional` limit: number

`Optional` limit: number

`Optional` limit: number

`Optional` limit: number

`Optional` limit: number

`Private` convertSingleSortOption

`Private` convertSortOptions

`Optional` options: string | BaseSortOptions | BaseSortOptions[]

`Private` convertUserOptions

Returns {
email: string;
order_by: any;
q: string;
}

`Optional` settings: LimitOptions

`Optional` settings: LimitOptions

`Optional` settings: GroupOptions = {}

`Optional` settings: TagOptions

`Optional` settings: UserOptions = {}

`Optional` settings: SingleGroupOptions

`Optional` settings: SortOptions

`Optional` settings: SingleGroupOptions

`Optional` settings: SortOptions

`Optional` options: DatasetSearchOptions