Interface Signer

A request signer.

This is the structural contract that every signing variant (e.g. SigV4, and future variants such as SigV4a) implements, and the contract that the createSignedFetcher factory depends on.

Implementations take a web-standard request and return a signed web-standard Request, performing no network I/O.

interface Signer {
    sign(
        input: string | URL | Request,
        init?: RequestInit,
    ): Promise<Request>;
}

Implemented by

SigV4Signer

Index

Methods

sign

Methods

sign

sign(input: string | URL | Request, init?: RequestInit): Promise<Request>
Sign a request and return a new, signed Request.
Parameters
- input: string | URL | Request
  The resource to sign, as a URL string, URL, or Request.
- Optionalinit: RequestInit
  Optional request options, matching the fetch init argument.
Returns Promise<Request>
- Defined in packages/signer/src/types/index.ts:23

Interface Signer

Implemented by

Index

Methods

Methods

sign

Parameters

Returns Promise<Request>

Settings

On This Page