_request_.request.md

WebSocketAPI - v1.1.5-1 › Globals › "Request" › Request

Class: Request

A simple api request

Hierarchy

• Request

  ↳ ServerRequest

Index

Constructors

• constructor

Properties

• _send
• _status
• body
• id
• method
• name

Methods

• send
• status

Constructors

constructor

+ new Request(id: number, name: string, body: object, method: string): Request

Defined in lib/Request.ts:11

Parameters:

Name	Type
id	number
name	string
body	object
method	string

Returns: Request

Properties

_send

• _send: function

Defined in lib/Request.ts:11

Type declaration:

▸ (value: any): void

Parameters:

Name	Type
value	any

---

_status

• _status: number

Defined in lib/Request.ts:10

---

body

• body: object

Defined in lib/Request.ts:8

---

id

• id: number

Defined in lib/Request.ts:6

---

method

• method: string

Defined in lib/Request.ts:9

---

name

• name: string

Defined in lib/Request.ts:7

Methods

send

▸ send(value: any): this

Defined in lib/Request.ts:59

Send a response to the client

Parameters:

Name	Type	Description
value	any	The value to send to client

Returns: this

---

status

▸ status(code: number): this

Defined in lib/Request.ts:49

Set the request status code

Parameters:

Name	Type	Description
code	number	The status code

Returns: this