Class AsyncRenewableBearer

constructor

• new AsyncRenewableBearer(
      source: Bearer,
      opts?: {
          cacheFilePath?: string;
          fileCacheThrottleMs?: number;
          initialRetryTimeoutMs?: number;
          initialSafetyMarginMs?: number | null;
          jitterFraction?: number;
          lifetimeSafeFraction?: number;
          logger?: Logger;
          maxRetries?: number;
          maxRetryTimeoutMs?: number;
          refreshRequestTimeoutMs?: number;
          retrySafetyMarginMs?: number;
          retryTimeoutExponent?: number;
          safetyMinRemainingMs?: number;
      },
  ): AsyncRenewableBearer

  Parameters

  • source: Bearer
  • Optionalopts: {
        cacheFilePath?: string;
        fileCacheThrottleMs?: number;
        initialRetryTimeoutMs?: number;
        initialSafetyMarginMs?: number | null;
        jitterFraction?: number;
        lifetimeSafeFraction?: number;
        logger?: Logger;
        maxRetries?: number;
        maxRetryTimeoutMs?: number;
        refreshRequestTimeoutMs?: number;
        retrySafetyMarginMs?: number;
        retryTimeoutExponent?: number;
        safetyMinRemainingMs?: number;
    }

  Returns AsyncRenewableBearer

Readonly$type

safetyMargin

wrapped

• get wrapped(): Bearer | undefined

  Returns Bearer | undefined

[customJson]

• "[customJson]"(): unknown

  Returns unknown

close

• close(graceMs?: number): Promise<void>

  Parameters

  • OptionalgraceMs: number

  Returns Promise<void>

fetch

• fetch(timeoutMs?: number, options?: AuthorizationOptions): Promise<Token>

  Parameters

  • OptionaltimeoutMs: number
  • Optionaloptions: AuthorizationOptions

  Returns Promise<Token>

isRenewalRequired

• isRenewalRequired(): boolean

  Returns boolean

receiver

• receiver(): Receiver

  Returns Receiver

requestRenewal

• requestRenewal(): void

  Returns void