Interface Middleware

Middleware that allows augmenting the client request/response with additional fields or headers.

interface Middleware {
    prepareRequest(
        resource: URL | Multiaddr[],
        opts: MiddlewareOptions,
    ): void | Promise<void>;
    processResponse(
        resource: URL | Multiaddr[],
        opts: MiddlewareOptions,
        response: Response,
    ): void | Promise<void>;
}

Implemented by

Index

Methods

prepareRequest? processResponse?

Methods

`Optional`prepareRequest

prepareRequest(
resource: URL | Multiaddr[],
opts: MiddlewareOptions,
): void | Promise<void>
Called before a request is made
Parameters
- resource: URL | Multiaddr[]
- opts: MiddlewareOptions
Returns void | Promise<void>
- Defined in packages/http-utils/dist/src/index.d.ts:32

`Optional`processResponse

processResponse(
    resource: URL | Multiaddr[],
    opts: MiddlewareOptions,
    response: Response,
): void | Promise<void>
Called after a request is made but before the body has been read - the processor may do any necessary housekeeping based on the server response
Parameters
- resource: URL | Multiaddr[]
- opts: MiddlewareOptions
- response: Response
Returns void | Promise<void>
- Defined in packages/http-utils/dist/src/index.d.ts:37