TimerConnection | blitztime

A connection to a timer socket.

Hierarchy

TimerConnection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TimerConnection(credentials: SocketCredentials, apiUrl: string): TimerConnection

- Defined in src/socket.ts:18
Connect to the socket and set up listeners.

Parameters
- credentials: SocketCredentials
- apiUrl: string
Returns TimerConnection

Properties

listeners

listeners: Map<EventName, ((data: Record<string, any>) => void)[]>

observer

observer: boolean

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

state

state: null | Timer

Methods

_onError

_onError(rawError: Record<string, any>): void

- Defined in src/socket.ts:120
Parameters
- rawError: Record<string, any>
Returns void

_onStateUpdate

_onStateUpdate(rawState: Record<string, any>): void

- Defined in src/socket.ts:115
Parameters
- rawState: Record<string, any>
Returns void

_triggerEvent

_triggerEvent(name: EventName, data: Record<string, any>): Promise<void>

- Defined in src/socket.ts:125
Parameters
- name: EventName
- data: Record<string, any>
Returns Promise<void>

addListener

addListener(event: EventName, listener: (data: Record<string, any>) => void): void

- Defined in src/socket.ts:65
Add a listener for an event.

Parameters
- event: EventName
- listener: (data: Record<string, any>) => void
  - - (data: Record<string, any>): void
    - Parameters
      - data: Record<string, any>
      Returns void
Returns void

addTime

addTime(seconds: number): void

- Defined in src/socket.ts:111
Add time to both player's clocks.

Parameters
- seconds: number
Returns void

connect

connect(): void

- Defined in src/socket.ts:51
Open the connection.

Returns void

disconnect

disconnect(): void

- Defined in src/socket.ts:58
Close the connection.

Returns void

endGame

endGame(): void

- Defined in src/socket.ts:106
End the game before the timer runs out.

Returns void

endTurn

endTurn(): void

- Defined in src/socket.ts:96
End the player's turn.

Returns void

removeListener

removeListener(event: EventName, listener: (data: Record<string, any>) => void): void

- Defined in src/socket.ts:78
Remove an added listener.

Parameters
- event: EventName
- listener: (data: Record<string, any>) => void
  - - (data: Record<string, any>): void
    - Parameters
      - data: Record<string, any>
      Returns void
Returns void

startTimer

startTimer(): void

- Defined in src/socket.ts:91
Start the timer once away has joined (host only).

Returns void

timeout

timeout(): void

- Defined in src/socket.ts:101
Notify the server that the current player has timed out.

Returns void

Generated using TypeDoc