Interface StreamMethodOptions

Hierarchy

  • MethodOptions
    • StreamMethodOptions

Properties

adapter? agent? baseURL? baseUrl? body? data? follow? headers? http2? maxContentLength? maxRedirects? method? onUploadProgress? params? paramsSerializer? responseType retry? retryConfig? rootUrl? signal? size? timeout? url? userAgentDirectives? validateStatus?

Properties

Optional adapter

adapter?: (<T>(options: GaxiosOptions, defaultAdapter: ((options: GaxiosOptions) => GaxiosPromise<T>)) => GaxiosPromise<T>)

Type declaration

    • <T>(options: GaxiosOptions, defaultAdapter: ((options: GaxiosOptions) => GaxiosPromise<T>)): GaxiosPromise<T>

    • Optional method to override making the actual HTTP request. Useful for writing tests.

      Type Parameters

      • T = any

      Parameters

      • options: GaxiosOptions
      • defaultAdapter: ((options: GaxiosOptions) => GaxiosPromise<T>)
          • (options: GaxiosOptions): GaxiosPromise<T>

          • Parameters

            • options: GaxiosOptions

            Returns GaxiosPromise<T>

      Returns GaxiosPromise<T>

Optional agent

agent?: Agent | ((parsedUrl: URL) => Agent)

Optional baseURL

baseURL?: string

Optional baseUrl

baseUrl?: string

Optional body

body?: any

Optional data

data?: any

Optional follow

follow?: number

Optional headers

headers?: Headers

Optional http2

http2?: boolean

Optional maxContentLength

maxContentLength?: number

The maximum size of the http response content in bytes allowed.

Optional maxRedirects

maxRedirects?: number

The maximum number of redirects to follow. Defaults to 20.

Optional method

method?: "GET" | "HEAD" | "POST" | "DELETE" | "PUT" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH"

Optional onUploadProgress

onUploadProgress?: ((progressEvent: any) => void)

Type declaration

    • (progressEvent: any): void

    • Parameters

      • progressEvent: any

      Returns void

Optional params

params?: any

Optional paramsSerializer

paramsSerializer?: ((params: {
    [index: string]: string | number;
}) => string)

Type declaration

    • (params: {
          [index: string]: string | number;
      }): string

    • Parameters

      • params: {
            [index: string]: string | number;
        }
        • [index: string]: string | number

      Returns string

responseType

responseType: "stream"

Optional retry

retry?: boolean

Optional retryConfig

retryConfig?: RetryConfig

Optional rootUrl

rootUrl?: string

Optional signal

signal?: AbortSignal

Optional size

size?: number

Optional timeout

timeout?: number

Optional url

url?: string

Optional userAgentDirectives

userAgentDirectives?: UserAgentDirective[]

Optional validateStatus

validateStatus?: ((status: number) => boolean)

Type declaration

    • (status: number): boolean

    • Parameters

      • status: number

      Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc