_serverrequest_.serverrequest.md

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

Class: ServerRequest

A simple api request

Hierarchy

• Request

  ↳ ServerRequest

Index

Constructors

• constructor

Properties

• WebSocket
• _send
• _status
• body
• client
• id
• method
• name
• request

Methods

• send
• status

Constructors

constructor

+ new ServerRequest(id: number, name: string, body: object, method: string, client: wsClient | null): ServerRequest

Overrides Request.constructor

Defined in lib/ServerRequest.ts:13

Parameters:

Name	Type
id	number
name	string
body	object
method	string
client	wsClient | null

Returns: ServerRequest

Properties

WebSocket

• WebSocket: WebSocket | null

Defined in lib/ServerRequest.ts:12

---

_send

• _send: function

Inherited from Request._send

Defined in lib/Request.ts:11

Type declaration:

▸ (value: any): void

Parameters:

Name	Type
value	any

---

_status

• _status: number

Inherited from Request._status

Defined in lib/Request.ts:10

---

body

• body: object

Inherited from Request.body

Defined in lib/Request.ts:8

---

client

• client: wsClient | null

Defined in lib/ServerRequest.ts:13

---

id

• id: number

Inherited from Request.id

Defined in lib/Request.ts:6

---

method

• method: string

Inherited from Request.method

Defined in lib/Request.ts:9

---

name

• name: string

Inherited from Request.name

Defined in lib/Request.ts:7

---

request

• request: ExpressRequest | null

Defined in lib/ServerRequest.ts:11

Methods

send

▸ send(value: any): this

Inherited from Request.send

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

Inherited from Request.status

Defined in lib/Request.ts:49

Set the request status code

Parameters:

Name	Type	Description
code	number	The status code

Returns: this