Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

accountProfile

accountProfile: (args: AccountProfile, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: AccountProfile, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: AccountProfile
      • Optional headers: Headers

      Returns ResourceResponse<any>

act

act: (args: undefined | null | ActOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: undefined | null | ActOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: undefined | null | ActOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

artisan

artisan: (args: ArtisanOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: ArtisanOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: ArtisanOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

axios

axios: AxiosInstance = ...

characterClass

characterClass: (args: CharacterClassOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: CharacterClassOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: CharacterClassOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

characterSkill

characterSkill: (args: CharacterSkillOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: CharacterSkillOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: CharacterSkillOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

defaults

defaults: { key: string; locale: Locales; origin: Origins; secret: string; token?: string }

Type declaration

  • key: string
  • locale: Locales
  • origin: Origins
  • secret: string
  • Optional token?: string

era

era: (args: undefined | null | EraOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: undefined | null | EraOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: undefined | null | EraOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

follower

follower: (args: FollowerOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: FollowerOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: FollowerOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

item

item: (args: ItemOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: ItemOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: ItemOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

itemType

itemType: (args: undefined | null | ItemTypeOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: undefined | null | ItemTypeOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: undefined | null | ItemTypeOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

recipe

recipe: (args: RecipeOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: RecipeOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: RecipeOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

season

season: (args: undefined | null | SeasonOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: undefined | null | SeasonOptions, headers?: Headers): ResourceResponse<any>
    • Parameters

      • args: undefined | null | SeasonOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

ua

ua: string = ...

version

version: string = '4.2.0'

Methods

createClientResourceRequest

  • createClientResourceRequest<T>(fn: ResourceInterface<T, any>): (args: T, headers?: Headers) => ResourceResponse<any>

getApplicationToken

  • getApplicationToken(args?: { key?: string; origin?: string; secret?: string }): Promise<AxiosResponse<AccessToken, any>>

getClientResource

  • getClientResource<T>(url: string, config?: AxiosRequestConfig<any>): Promise<AxiosResponse<T, any>>

prepareResourceRequest

  • prepareResourceRequest(resource: Resource<{}>, args?: Partial<ClientOptions>, headers?: Headers): [string, AxiosRequestConfig<any>]

refreshApplicationToken

  • refreshApplicationToken(args?: { key?: string; origin?: string; secret?: string }): Promise<AxiosResponse<AccessToken, any>>

setApplicationToken

  • setApplicationToken(token: string): void

validateApplicationToken

  • validateApplicationToken(args?: { origin?: string; token?: string }): Promise<AxiosResponse<{ authorities: { authority: string }[]; client_id: string; exp: number; scope?: string[] }, any>>

Generated using TypeDoc