Class MetalEvent

Hierarchy

MetalEvent

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MetalEvent(config: ClientConfig): MetalEvent

- Defined in src/metal-event.ts:43
Parameters
- config: ClientConfig
Returns MetalEvent

Properties

Private client

client: WebSocket

Protected config

config: ClientConfig

connected

connected: EventEmitter = ...

disconnected

disconnected: EventEmitter = ...

message

message: EventEmitter = ...

Private queues

queues: RequestQueue[] = ...

Private requests

requests: Requests = ...

Private retries

retries: number = 0

status

status: "init" | "ready" = 'init'

Private subscriptions

subscriptions: {} = ...

Type declaration

[id: string]: Subscriber<any>[]

Accessors

Private baseURL

get baseURL(): string

- Defined in src/metal-event.ts:37
Returns string

readyState

get readyState(): number

- Defined in src/metal-event.ts:41
Returns number

Methods

connect

connect(reconnect?: boolean): void

- Defined in src/metal-event.ts:55
Parameters
- Optional reconnect: boolean
Returns void

Protected createRequest

createRequest<R>(config: RequestConfig<R>): ClientRequest<R>

- Defined in src/metal-event.ts:240
Type parameters
- R
Parameters
- config: RequestConfig<R>
Returns ClientRequest<R>

Protected createURL

createURL(url: string, params?: QueryParams): string

- Defined in src/metal-event.ts:256
Parameters
- url: string
- params: QueryParams = ...
Returns string

delete

delete<D>(url: string, options?: RequestOptions): Promise<ServerResponse<D>>

- Defined in src/metal-event.ts:141
Type parameters
- D
Parameters
- url: string
- Optional options: RequestOptions
Returns Promise<ServerResponse<D>>

get

get<D>(url: string, options?: RequestOptions): Promise<ServerResponse<D>>

- Defined in src/metal-event.ts:118
Type parameters
- D
Parameters
- url: string
- Optional options: RequestOptions
Returns Promise<ServerResponse<D>>

options

options(url: string, options?: RequestOptions): Promise<ServerResponse<void>>

- Defined in src/metal-event.ts:148
Parameters
- url: string
- Optional options: RequestOptions
Returns Promise<ServerResponse<void>>

post

post<R, D>(url: string, data: R, options?: RequestOptions): Promise<ServerResponse<D>>

- Defined in src/metal-event.ts:125
Type parameters
- R
- D
Parameters
- url: string
- data: R
- Optional options: RequestOptions
Returns Promise<ServerResponse<D>>

put

put<R, D>(url: string, data: R, options?: RequestOptions): Promise<ServerResponse<D>>

- Defined in src/metal-event.ts:133
Type parameters
- R
- D
Parameters
- url: string
- data: R
- Optional options: RequestOptions
Returns Promise<ServerResponse<D>>

request

request<R, D>(config: RequestConfig<R>): Promise<ServerResponse<D>>

- Defined in src/metal-event.ts:155
Type parameters
- R
- D
Parameters
- config: RequestConfig<R>
Returns Promise<ServerResponse<D>>

Protected submit

submit<R, D>(message: ClientMessage<R>, options?: RequestOptions): Promise<ServerResponse<D>>

- Defined in src/metal-event.ts:264
Type parameters
- R
- D
Parameters
- message: ClientMessage<R>
- options: RequestOptions = ...
Returns Promise<ServerResponse<D>>

subscribe

subscribe<D>(path: string, handler: SubscriptionHandler<D>, options?: RequestOptions): Promise<Subscription<D>>

- Defined in src/metal-event.ts:164
Type parameters
- D
Parameters
- path: string
- handler: SubscriptionHandler<D>
- options: RequestOptions = ...
Returns Promise<Subscription<D>>

Protected unsubscribe

unsubscribe(path: string, options?: RequestOptions): Promise<void>

- Defined in src/metal-event.ts:216
Parameters
- path: string
- Optional options: RequestOptions
Returns Promise<void>

Generated using TypeDoc