Class BasicResponseWriter

Writes to an HttpResponse based on the incoming ResponseDescription.

Hierarchy

ResponseWriter
- BasicResponseWriter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasicResponseWriter(metadataWriter: MetadataWriter): BasicResponseWriter

Overrides ResponseWriter.constructor
- Defined in src/http/output/BasicResponseWriter.ts:17
Parameters
- metadataWriter: MetadataWriter
Returns BasicResponseWriter

Properties

Protected Readonly logger

logger: Logger = ...

Private Readonly metadataWriter

metadataWriter: MetadataWriter

Methods

canHandle

canHandle(input: { response: ServerResponse; result: ResponseDescription }): Promise<void>

Overrides ResponseWriter.canHandle
- Defined in src/http/output/BasicResponseWriter.ts:22
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: { response: ServerResponse; result: ResponseDescription }
  - response: ServerResponse
  - result: ResponseDescription
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(input: { response: ServerResponse; result: ResponseDescription }): Promise<void>

Overrides ResponseWriter.handle
- Defined in src/http/output/BasicResponseWriter.ts:29
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- input: { response: ServerResponse; result: ResponseDescription }
  - response: ServerResponse
  - result: ResponseDescription
Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: { response: ServerResponse; result: ResponseDescription }): Promise<void>

Inherited from ResponseWriter.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

Parameters
- input: { response: ServerResponse; result: ResponseDescription }
  
  Input data that will be handled if it can be handled.
  - response: ServerResponse
  - result: ResponseDescription
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.