Class HawAPIClient

constructor

• new HawAPIClient(options?): HawAPIClient

• Parameters

  • Optional options: Partial<HawAPIOptions>

  Returns HawAPIClient

cache

headers

options

request

service

cacheKeys

• cacheKeys(): Promise<IterableIterator<string>>

• Method to get all keys of cached data

  Returns Promise<IterableIterator<string>>

  All cached keys

cacheSize

• cacheSize(): Promise<number>

• Method to get the size of cached data

  Returns Promise<number>

  The count of all cached data

clearCache

• clearCache(): Promise<number>

• Method to clear all cached data

  Returns Promise<number>

  The count of all cleaned data

getAll

• getAll<T>(target, filters?, pageable?): Promise<RequestResult<T[]>>

• Method that get all items

  Type Parameters

  • T extends BaseModel

  Parameters

  • target: "actors" | "characters" | "episodes" | "games" | "locations" | "seasons" | "soundtracks"

    The target name

  • Optional filters: null | Filters

  • Optional pageable: null | Pageable

  Returns Promise<RequestResult<T[]>>

  An new RequestResult with all target items

getAllSocials

• getAllSocials(uuid): Promise<RequestResult<ActorSocialModel[]>>

• Method that get all actor socials

  Parameters

  • uuid: string

    The actor uuid

  Returns Promise<RequestResult<ActorSocialModel[]>>

  An new RequestResult with all actor socials

getAllTranslations

• getAllTranslations<T>(target, uuid): Promise<RequestResult<T[]>>

• Method that get all item translations

  Type Parameters

  • T extends BaseTranslation

  Parameters

  • target: "actors" | "characters" | "episodes" | "games" | "locations" | "seasons" | "soundtracks"

    The target name

  • uuid: string

    The target uuid

  Returns Promise<RequestResult<T[]>>

  An new RequestResult with all target item translations

getBy

• getBy<T>(target, uuid): Promise<RequestResult<T>>

• Method that get a single item

  Type Parameters

  • T extends BaseModel

  Parameters

  • target: "actors" | "characters" | "episodes" | "games" | "locations" | "seasons" | "soundtracks"

    The target name

  • uuid: string

    The target uuid

  Returns Promise<RequestResult<T>>

  An new RequestResult with specific target item

getInfo

• getInfo(): Promise<APIInfoModel>

• Method to get all API informations

  Returns Promise<APIInfoModel>

  An new APIInfoModel

getOptions

• getOptions(): Promise<HawAPIOptions>

• Method to get all client options

  Returns Promise<HawAPIOptions>

  The current HawAPIOptions (without token)

getOverview

• getOverview<OverviewModel>(language?): Promise<RequestResult<OverviewModel>>

• Method that get the API overview

  Type Parameters

  • OverviewModel

  Parameters

  • Optional language: string

    The result language

  Returns Promise<RequestResult<OverviewModel>>

  An new RequestResult with overview

getRandom

• getRandom<T>(target): Promise<RequestResult<T>>

• Method that get a single random item

  Type Parameters

  • T extends BaseModel

  Parameters

  • target: "actors" | "characters" | "episodes" | "games" | "locations" | "seasons" | "soundtracks"

    The target name

  Returns Promise<RequestResult<T>>

  An new RequestResult with random target item

getRandomSocial

• getRandomSocial(uuid): Promise<RequestResult<ActorSocialModel>>

• Method that get a single random actor social

  Parameters

  • uuid: string

    The actor uuid

  Returns Promise<RequestResult<ActorSocialModel>>

  An new RequestResult with random social

getRandomTranslation

• getRandomTranslation<T>(target, uuid): Promise<RequestResult<T>>

• Method that get a single random item translation

  Type Parameters

  • T extends BaseModel

  Parameters

  • target: "actors" | "characters" | "episodes" | "games" | "locations" | "seasons" | "soundtracks"

    The target name

  • uuid: string

    The target uuid

  Returns Promise<RequestResult<T>>

  An new RequestResult with random target item translation

getSocialBy

• getSocialBy(uuid, social): Promise<RequestResult<ActorSocialModel>>

• Method that get a single actor social

  Parameters

  • uuid: string

    The actor uuid

  • social: string

    The social name

  Returns Promise<RequestResult<ActorSocialModel>>

  An new RequestResult with an specific actor social

getTranslationBy

• getTranslationBy<T>(target, uuid, language): Promise<RequestResult<T>>

• Method that get a single item

  Type Parameters

  • T extends BaseTranslation

  Parameters

  • target: "actors" | "characters" | "episodes" | "games" | "locations" | "seasons" | "soundtracks"

    The target name

  • uuid: string

    The target uuid

  • language: string

    The target translation language

  Returns Promise<RequestResult<T>>

  An new RequestResult with specific target item translation

ping

• ping(): Promise<string>

• Method to test API connection

  Returns Promise<string>

  If connected. An string with 'Ping' value

removeCache

• removeCache(key): Promise<boolean>

• Method to remove specific cache data

  Parameters

  • key: string

    The cache key

  Returns Promise<boolean>

  true if an element in the Map existed and has been removed, or false if the element does not exist.

setLanguage

• setLanguage(language): Promise<void>

• Method to define new language into client options

  Parameters

  • language: string

  Returns Promise<void>