Class WsClient

A client for the Hrana protocol over a WebSocket.

Hierarchy

Client
- WsClient

Implements

SqlOwner

Index

Properties

intMode

intMode: IntMode

Representation of integers returned from the database. See IntMode.

This value is inherited by Stream objects created with openStream, but you can override the integer mode for every stream by setting intMode on the stream.

Accessors

closed

get closed(): boolean
True if the client is closed.

Returns boolean
Overrides Client.closed
- Defined in src/ws/client.ts:371

Methods

close

close(): void
Close the client and the WebSocket.

Returns void
Overrides Client.close
- Defined in src/ws/client.ts:366

getVersion

getVersion(): Promise<ProtocolVersion>
Get the protocol version negotiated with the server, possibly waiting until the socket is open.

Returns Promise<ProtocolVersion>
Overrides Client.getVersion
- Defined in src/ws/client.ts:161

openStream

openStream(): WsStream
Open a WsStream, a stream for executing SQL statements.

Returns WsStream
Overrides Client.openStream
- Defined in src/ws/client.ts:334

storeSql

storeSql(sql): Sql
Cache a SQL text on the server. This requires protocol version 2 or higher.
Parameters
- sql: string
Returns Sql
Implementation of SqlOwner.storeSql
- Defined in src/ws/client.ts:339

Class WsClient

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

intMode

Accessors

closed

Returns boolean

Methods

close

Returns void

getVersion

Returns Promise<ProtocolVersion>

openStream

Returns WsStream

storeSql

Parameters

sql: string

Returns Sql

Settings

Member Visibility

Theme

On This Page