Class WsEndpoint

WebSocket connection to Chronik.

Hierarchy

WsEndpoint

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WsEndpoint(wsUrl: string, config: WsConfig): WsEndpoint

- Defined in index.ts:254
Parameters
- wsUrl: string
- config: WsConfig
Returns WsEndpoint

Properties

autoReconnect

autoReconnect: boolean

Whether to automatically reconnect on disconnect, default true.

Optional onConnect

onConnect?: (e: Event) => void

Type declaration

- (e: Event): void
- Fired when a connection has been (re)established.
  
  Parameters
  - e: Event
  Returns void

Optional onEnd

onEnd?: (e: Event) => void

Type declaration

- (e: Event): void
- Fired after a connection has been manually closed, or if autoReconnect is false, if the WebSocket disconnects for any reason.
  
  Parameters
  - e: Event
  Returns void

Optional onError

onError?: (e: ErrorEvent) => void

Type declaration

- (e: ErrorEvent): void
- Fired when an error with the WebSocket occurs.
  
  Parameters
  - e: ErrorEvent
  Returns void

Optional onMessage

onMessage?: (msg: SubscribeMsg) => void

Type declaration

- (msg: SubscribeMsg): void
- Fired when a message is sent from the WebSocket.
  
  Parameters
  - msg: SubscribeMsg
  Returns void

Optional onReconnect

onReconnect?: (e: Event) => void

Type declaration

- (e: Event): void
- Fired after a connection has been unexpectedly closed, and before a reconnection attempt is made. Only fired if autoReconnect is true.
  
  Parameters
  - e: Event
  Returns void

Methods

close

close(): void

- Defined in index.ts:294
Close the WebSocket connection and prevent future any reconnection attempts.

Returns void

subscribe

subscribe(scriptType: ScriptType, scriptPayload: string): void

- Defined in index.ts:274
Subscribe to the given script type and payload. For "p2pkh", scriptPayload is the 20 byte public key hash.

Parameters
- scriptType: ScriptType
- scriptPayload: string
Returns void

unsubscribe

unsubscribe(scriptType: ScriptType, scriptPayload: string): void

- Defined in index.ts:282
Unsubscribe from the given script type and payload.

Parameters
- scriptType: ScriptType
- scriptPayload: string
Returns void

waitForOpen

waitForOpen(): Promise<void>

- Defined in index.ts:268
Wait for the WebSocket to be connected.

Returns Promise<void>

Generated using TypeDoc