Class PeerIdAuth

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

Implements

Middleware

Index

Constructors

Methods

createAuthToken getOrCreateAuthToken prepareRequest processResponse

Constructors

constructor

new PeerIdAuth(
components: PeerIdAuthComponents,
init: PeerIdAuthInit,
): PeerIdAuth
Parameters
- components: PeerIdAuthComponents
- init: PeerIdAuthInit
Returns PeerIdAuth
- Defined in packages/http/src/middleware/peer-id-auth.ts:50

Methods

createAuthToken

createAuthToken(
resource: URL | Multiaddr[],
opts: MiddlewareOptions,
): Promise<string>
Parameters
- resource: URL | Multiaddr[]
- opts: MiddlewareOptions
Returns Promise<string>
- Defined in packages/http/src/middleware/peer-id-auth.ts:92

getOrCreateAuthToken

getOrCreateAuthToken(
resource: URL | Multiaddr[],
opts: MiddlewareOptions,
): Promise<string>
Parameters
- resource: URL | Multiaddr[]
- opts: MiddlewareOptions
Returns Promise<string>
- Defined in packages/http/src/middleware/peer-id-auth.ts:74

prepareRequest

prepareRequest(
resource: URL | Multiaddr[],
opts: MiddlewareOptions,
): Promise<void>
Called before a request is made
Parameters
- resource: URL | Multiaddr[]
- opts: MiddlewareOptions
Returns Promise<void>
Implementation of Middleware.prepareRequest
- Defined in packages/http/src/middleware/peer-id-auth.ts:57

processResponse

processResponse(
    resource: URL | Multiaddr[],
    opts: MiddlewareOptions,
    response: Response,
): 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
Implementation of Middleware.processResponse
- Defined in packages/http/src/middleware/peer-id-auth.ts:140