Interface UriHandler

Provides a way for a lens to call into external services that work under HTTP-like protocol.

Hierarchy

UriHandler

Index

Properties

Methods

handleRequest cancelRequest?

Properties

uri

uri: `${string}://${string}` | `${string}://${string}`[]

[scheme]://[route] pattern that this handler processes or an array of patterns.

Methods

handleRequest

handleRequest(request, reply, lens): void
Called to process the provided request.
Parameters
- request: UriRequest
  
  Lens request.
- reply: ((response) => void)
  
  A callback function to send response back. The function can be called none or multiple number of times.
  - - (response): void
    - Parameters
      
      response: UriResponse
      
      Returns void
- lens: Lens
  
  Lens the request is coming from.
Returns void

`Optional` cancelRequest

cancelRequest(request, lens): void
Called to indicated that URI request initated earlier is cancelled.
Parameters
- request: UriCancelRequest
  
  Lens request.
- lens: Lens
  
  Lens the request is coming from.
Returns void

Generated using TypeDoc