fetch | @pagopa/ts-commons

Index

Type aliases

AbortableFetch

Functions

Type aliases

AbortableFetch

AbortableFetch: (input: Request | string, init?: RequestInit) => ITuple2<Promise<Response>, AbortController>

An instance of fetch, along its associated AbortController

Type declaration

- (input: Request | string, init?: RequestInit): ITuple2<Promise<Response>, AbortController>
- Parameters
  - input: Request | string
  - Optional init: RequestInit
  Returns ITuple2<Promise<Response>, AbortController>

Functions

AbortableFetch

AbortableFetch(origFetch?: typeof __type): AbortableFetch

- Defined in src/fetch.ts:34
Makes fetch abortable and returns an AbortableFetch.

The fetch request can be aborted by calling AbortController's abort().

See https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort

Parameters
- origFetch: typeof __type = ...
Returns AbortableFetch

Const retriableFetch

retriableFetch(retryWrapper: (_: TaskEither<Error | "transient", Response>, shouldAbort?: Promise<boolean>) => TaskEither<Error | "max-retries" | "retry-aborted", Response>, shouldAbort?: Promise<boolean>): (f: (input: RequestInfo, init?: RequestInit) => Promise<Response>) => (input: RequestInfo, init?: RequestInit) => Promise<Response>

- Defined in src/fetch.ts:91
Given a function that wraps a RetriableTask with retries, it returns an fetch that wraps the original fetch with retries on transient errors such as network errors and timeouts.

Parameters
- retryWrapper: (_: TaskEither<Error | "transient", Response>, shouldAbort?: Promise<boolean>) => TaskEither<Error | "max-retries" | "retry-aborted", Response>
  - - (_: TaskEither<Error | "transient", Response>, shouldAbort?: Promise<boolean>): TaskEither<Error | "max-retries" | "retry-aborted", Response>
    - Parameters
      - _: TaskEither<Error | "transient", Response>
      - Optional shouldAbort: Promise<boolean>
      Returns TaskEither<Error | "max-retries" | "retry-aborted", Response>
- Optional shouldAbort: Promise<boolean>
Returns (f: (input: RequestInfo, init?: RequestInit) => Promise<Response>) => (input: RequestInfo, init?: RequestInit) => Promise<Response>
- - (f: (input: RequestInfo, init?: RequestInit) => Promise<Response>): (input: RequestInfo, init?: RequestInit) => Promise<Response>
  - Parameters
    - f: (input: RequestInfo, init?: RequestInit) => Promise<Response>
      - (input: RequestInfo, init?: RequestInit): Promise<Response>
        
        Parameters
        
        input: RequestInfo
        
        Optional init: RequestInit
        
        Returns Promise<Response>
    Returns (input: RequestInfo, init?: RequestInit) => Promise<Response>
    - - (input: RequestInfo, init?: RequestInit): Promise<Response>
      - Parameters
        
        input: RequestInfo
        
        Optional init: RequestInit
        
        Returns Promise<Response>

setFetchTimeout

setFetchTimeout(timeout: Millisecond, abortableFetch: AbortableFetch): AbortableFetch

- Defined in src/fetch.ts:70
Sets a timeout on an AbortableFetch.

When the timeout expires, the controller's abort() method gets called.

Parameters
- timeout: Millisecond
- abortableFetch: AbortableFetch
Returns AbortableFetch

Const toFetch

toFetch(f: AbortableFetch): (input: RequestInfo, init?: RequestInit) => Promise<Response>

- Defined in src/fetch.ts:60
Converts an AbortableFetch back to a simple fetch

Parameters
- f: AbortableFetch
Returns (input: RequestInfo, init?: RequestInit) => Promise<Response>
- - (input: RequestInfo, init?: RequestInit): Promise<Response>
  - Parameters
    - input: RequestInfo
    - Optional init: RequestInit
    Returns Promise<Response>

Generated using TypeDoc

Index

Type aliases

Functions

Type aliases

AbortableFetch

Type declaration

Parameters

input: Request | string

Optional init: RequestInit

Returns ITuple2<Promise<Response>, AbortController>

Functions

AbortableFetch

Parameters

origFetch: typeof __type = ...

Returns AbortableFetch

Const retriableFetch

Parameters

retryWrapper: (_: TaskEither<Error | "transient", Response>, shouldAbort?: Promise<boolean>) => TaskEither<Error | "max-retries" | "retry-aborted", Response>

Parameters

_: TaskEither<Error | "transient", Response>

Optional shouldAbort: Promise<boolean>

Returns TaskEither<Error | "max-retries" | "retry-aborted", Response>

Optional shouldAbort: Promise<boolean>

Returns (f: (input: RequestInfo, init?: RequestInit) => Promise<Response>) => (input: RequestInfo, init?: RequestInit) => Promise<Response>

Parameters

f: (input: RequestInfo, init?: RequestInit) => Promise<Response>

Parameters

input: RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Returns (input: RequestInfo, init?: RequestInit) => Promise<Response>

Parameters

input: RequestInfo

Optional init: RequestInit

Returns Promise<Response>

setFetchTimeout

Parameters

timeout: Millisecond

abortableFetch: AbortableFetch

Returns AbortableFetch

Const toFetch

Parameters

f: AbortableFetch

Returns (input: RequestInfo, init?: RequestInit) => Promise<Response>

Parameters

input: RequestInfo

Optional init: RequestInit

Returns Promise<Response>