Properties
accessToken
accessToken: string
apiCacheKey
apiCacheKey: string
apiDataTTL
apiDataTTL: number
bookmarks
bookmarks: string[]
oauthInitiate
oauthInitiate: string
oauthToken
oauthToken: string
quickRoutes
quickRoutes: any
Methods
get
- get(callback: function): Promise<IApi>
-
Parameters
-
callback: function
-
- (err: Error | null, value?: any, xhr?: any, ttl?: undefined | number): void
-
Parameters
-
err: Error | null
-
Optional value: any
-
Optional xhr: any
-
Optional ttl: undefined | number
Returns void
Returns Promise<IApi>
getQuickRoutes
- getQuickRoutes(callback: function): Promise<any>
-
Parameters
-
callback: function
-
- (err: Error, data: any, xhr: any): void
-
Parameters
-
err: Error
-
data: any
-
xhr: any
Returns void
Returns Promise<any>
parse
-
Parameters
Returns object
query
- query(q: string | string[], optionsOrCallback: any | function, cb: function): Promise<IApiResponse>
-
Parameters
-
q: string | string[]
-
optionsOrCallback: any | function
-
cb: function
-
- (err: Error | null, response?: any): void
-
Parameters
-
err: Error | null
-
Optional response: any
Returns void
quickRoutesEnabled
- quickRoutesEnabled(): boolean
ref
- ref(label: string): string | null
-
Parameters
Returns string
|
null
refresh
-
Parameters
-
callback: function
-
- (err: Error | null | undefined, data: any, xhr: any): void
-
Parameters
-
err: Error | null | undefined
-
data: any
-
xhr: any
Returns void
request
- request(url: string, callback: function): PromiseLike<IApiResponse>
-
Parameters
-
url: string
-
callback: function
-
- (err: Error | null, results: IApiResponse | null, xhr?: any): void
-
Parameters
-
err: Error | null
-
-
Optional xhr: any
Returns void