| 1 | /**
|
| 2 | * -------------------------------------------------------------------------------------------
|
| 3 | * Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License.
|
| 4 | * See License in the project root for license information.
|
| 5 | * -------------------------------------------------------------------------------------------
|
| 6 | */
|
| 7 |
|
| 8 | /**
|
| 9 | * @interface {@link https://github.com/bitinn/node-fetch/#options}
|
| 10 | * Signature to define the fetch request options for node environment
|
| 11 | * @property {number} [follow] - node-fetch option: maximum redirect count. 0 to not follow redirect
|
| 12 | * @property {number} [compress] - node-fetch option: support gzip/deflate content encoding. false to disable
|
| 13 | * @property {number} [size] - node-fetch option: maximum response body size in bytes. 0 to disable
|
| 14 | * @property {any} [agent] - node-fetch option: HTTP(S).Agent instance, allows custom proxy, certificate, lookup, family etc.
|
| 15 | * @property {number} [highWaterMark] - node-fetch option: maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource.
|
| 16 | * @property {boolean} [insecureHTTPParser] - node-fetch option: use an insecure HTTP parser that accepts invalid HTTP headers when `true`.
|
| 17 | */
|
| 18 | export interface NodeFetchInit {
|
| 19 | follow?: number;
|
| 20 | compress?: boolean;
|
| 21 | size?: number;
|
| 22 | agent?: any;
|
| 23 | highWaterMark?: number;
|
| 24 | insecureHTTPParser?: boolean;
|
| 25 | }
|
| 26 |
|
| 27 | /**
|
| 28 | * @interface
|
| 29 | * Signature to define the fetch api options which includes both fetch standard options and also the extended node fetch options
|
| 30 | * @extends RequestInit @see {@link https://fetch.spec.whatwg.org/#requestinit}
|
| 31 | * @extends NodeFetchInit
|
| 32 | */
|
| 33 | export interface FetchOptions extends RequestInit, NodeFetchInit {}
|