Class AsyncResource<T>

constructor

• new AsyncResource<T>(params: AsyncResourceOptions<T>): AsyncResource<T>

• Type Parameters

  • T

  Parameters

  • params: AsyncResourceOptions<T>

  Returns AsyncResource<T>

ReadonlyonUpdated

Readonlyparams

isStale

• get isStale(): boolean

• Returns boolean

destroy

• destroy(): void

• Returns void

get

• get(): Promise<null | T>

• get the resource value, refreshing it if needed

  note: this method still might return null if the resource wasn't ever cached yet, and the underlying call to fetcher failed

  Returns Promise<null | T>

getCached

• getCached(): null | T

• get the cached resource value immediately (if any) note that it may be stale, which you should check separately

  Returns null | T

setData

• setData(data: T, expiresIn: number): void

• Parameters

  • data: T
  • expiresIn: number

  Returns void

update

• update(force?: boolean): Promise<void>

• update the resource

  Parameters

  • force: boolean = false

    whether to force the update even if the resource hasn't expired yet

  Returns Promise<void>