Class HTTPError

constructor

• new HTTPError(
      msg: string,
      httpStatus?: number,
      httpHeaders?: Headers,
  ): HTTPError

  Parameters

  • msg: string
  • OptionalhttpStatus: number
  • OptionalhttpHeaders: Headers

  Returns HTTPError

Optional ReadonlyhttpHeaders

Optional ReadonlyhttpStatus

getRetryAfterMs

• getRetryAfterMs(): null | number

  Returns null | number

  The recommended delay in milliseconds to wait before retrying the request that triggered this error, or null if no delay is recommended.

  Throws

  Error if the recommended delay is an invalid value.

  See

  safeGetRetryAfterMs for a version of this check that doesn't throw.

isRateLimitError

• isRateLimitError(): boolean

  Check if this error was due to rate-limiting on the server side (and should therefore be retried after a delay).

  If this returns true, getRetryAfterMs can be called to retrieve the server-side recommendation for the retry period.

  Returns boolean

  Whether this error is due to rate-limiting.