Class OkResponseDescription

Corresponds to a 200 response, containing relevant metadata and potentially data.

Hierarchy

ResponseDescription
- OkResponseDescription

Index

Constructors

constructor

Properties

Constructors

constructor

new OkResponseDescription(metadata: RepresentationMetadata, data?: Guarded<Readable>): OkResponseDescription

Overrides ResponseDescription.constructor
- Defined in src/http/output/response/OkResponseDescription.ts:14
Parameters
- metadata: RepresentationMetadata
  
  Metadata concerning the response.
- Optional data: Guarded<Readable>
  
  Potential data. @ignored
Returns OkResponseDescription

Properties

Optional Readonly data

data?: Guarded<Readable>

Optional Readonly metadata

metadata?: RepresentationMetadata

Readonly statusCode

statusCode: number