Class HawAPIOptions

The HawAPI options configuration.

Hierarchy

  • HawAPIOptions

Constructors

Properties

endpoint: string = API_URL

The endpoint of the HawAPI instance

Default

'https://hawapi.theproject.id/api'
inMemoryCache: boolean

Define if the package should save (in-memory) all request results

Default

true
language?: string

The language of items for all requests

Note: This value can be overwritten later

Default

'en-US'
size?: number

The size of items for all requests

Note: This value can be overwritten later

Default

10
timeout: number

The timeout of a response in milliseconds

Default

10 * 1000 // (10 seconds)
token?: string

The HawAPI token (JWT)
By default, all requests are made with 'ANONYMOUS' tier with limit of 16 req/60s

See more https://hawapi.theproject.id/docs/guides/rate-limiting

version: string = API_VERSION

The version of the API

Default

'v1'

Generated using TypeDoc