Class MetalEvent

Hierarchy

MetalEvent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MetalEvent(server: Server, config?: ServerConfig): MetalEvent

- Defined in server.ts:35
Parameters
- server: Server
- config: ServerConfig = ...
Returns MetalEvent

Properties

Private middlewares

middlewares: RequestMiddleware[] = ...

Private router

router: Router = ...

Private socket

socket: Server

Private subscriptions

subscriptions: Subscriptions = ...

Private users

users: Users = ...

Methods

all

all<R, D>(path: string, handler: RequestHandler<R, D>): MetalEvent

- Defined in server.ts:55
Type parameters
- R
- D
Parameters
- path: string
- handler: RequestHandler<R, D>
Returns MetalEvent

Protected cleanup

cleanup(): void

- Defined in server.ts:251
Returns void

Protected connect

connect(client: WebSocket, request: IncomingMessage): void

- Defined in server.ts:96
Parameters
- client: WebSocket
- request: IncomingMessage
Returns void

delete

delete<D>(path: string, handler: RequestHandler<null, D>): MetalEvent

- Defined in server.ts:87
Type parameters
- D
Parameters
- path: string
- handler: RequestHandler<null, D>
Returns MetalEvent

emit

emit<T>(event: ServerEvent<T>): void

- Defined in server.ts:92
Type parameters
- T
Parameters
- event: ServerEvent<T>
Returns void

get

get<D>(path: string, handler: RequestHandler<null, D>): MetalEvent

- Defined in server.ts:67
Type parameters
- D
Parameters
- path: string
- handler: RequestHandler<null, D>
Returns MetalEvent

options

options(path: string, handler: RequestHandler<null, null>): MetalEvent

- Defined in server.ts:82
Parameters
- path: string
- handler: RequestHandler<null, null>
Returns MetalEvent

patch

patch<R, D>(path: string, handler: RequestHandler<R, D>): MetalEvent

- Defined in server.ts:77
Type parameters
- R
- D
Parameters
- path: string
- handler: RequestHandler<R, D>
Returns MetalEvent

post

post<R, D>(path: string, handler: RequestHandler<R, D>): MetalEvent

- Defined in server.ts:62
Type parameters
- R
- D
Parameters
- path: string
- handler: RequestHandler<R, D>
Returns MetalEvent

put

put<R, D>(path: string, handler: RequestHandler<R, D>): MetalEvent

- Defined in server.ts:72
Type parameters
- R
- D
Parameters
- path: string
- handler: RequestHandler<R, D>
Returns MetalEvent

Protected response

response<R, D>(user: User, message: ClientMessage<R>): Promise<void>

- Defined in server.ts:124
Type parameters
- R
- D
Parameters
- user: User
- message: ClientMessage<R>
Returns Promise<void>

Protected subscription

subscription(user: User, message: ClientMessage<any>): Promise<void>

- Defined in server.ts:186
Parameters
- user: User
- message: ClientMessage<any>
Returns Promise<void>

use

use(middleware: RequestMiddleware): MetalEvent

- Defined in server.ts:50
Parameters
- middleware: RequestMiddleware
Returns MetalEvent

Generated using TypeDoc