Class StatusDTO

description: A DTO class that consists of a status property only and can be used to determine the correct execution of requests.

This class shall be used in HTTP responses to avoid any additional data about module states to be revealed.
since: v0.3.0

Hierarchy

BaseDTO
- StatusDTO

Index

Constructors

constructor

Properties

Methods

create

Constructors

constructor

new StatusDTO(data?: any): StatusDTO

Inherited from BaseDTO.constructor
- Defined in src/common/models/BaseDTO.ts:28
Constructs an instance of this DTO.

Parameters
- data: any = {}
Returns StatusDTO

Properties

code

code: number

Contains the HTTP status code sent with the response object. Successful requests shall contain 200 as the status code.

access: public
var: {number}

status

status: boolean

Contains true given a successful request, or false otherwise.

access: public
var: {string}

Methods

Static create

create(code: number): StatusDTO

- Defined in src/common/models/StatusDTO.ts:65
Creates an object instance of this DTO.

access
public

static
Parameters
- code: number
  
  The HTTP status code sent with the response object.
Returns StatusDTO
The created instance of this class, with provided code.

Generated using TypeDoc