@naturalcycles/nodejs-lib/src/got/got.model.ts

Standard library for Node.js

export interface GetGotOptions extends GotBeforeRequestHookOptions, GotAfterResponseHookOptions {}

export interface GotErrorHookOptions extends GotMaxResponseLength {}

export interface GotBeforeRequestHookOptions {
  /**
   * @default false
   */
  logStart?: boolean
}

export interface GotAfterResponseHookOptions extends GotMaxResponseLength {
  /**
   * Log when request is finished.
   * @default false
   */
  logFinished?: boolean

  /**
   * Log actual response object.
   *
   * @default false
   */
  logResponse?: boolean
}

export interface GotMaxResponseLength {
  /**
   * Max length of response object before it's truncated.
   *
   * @default 10_000
   */
  maxResponseLength?: number
}

export interface GotRequestContext {
  /**
   * Millisecond-timestamp of when the request was started. To be able to count "time spent".
   */
  started: number
}