Class StevesDBClient

Hierarchy

StevesDBClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StevesDBClient(): StevesDBClient

- Defined in stevesdbclient.ts:89
Returns StevesDBClient

Properties

Static Readonly CLIENT_VERSION

CLIENT_VERSION: string = require("../package.json").version

Version of the client itself

Static Readonly PROTOCOL_VERSION

PROTOCOL_VERSION: number = 2

The protocol version this client was made against

Methods

connect

connect(host: string, port?: number, options?: { encryption: boolean }): Promise<void>

- Defined in stevesdbclient.ts:101
Connect to a database

Parameters
- host: string
  
  server host
- Default value port: number = 2540
  
  server port
- Default value options: { encryption: boolean } = {encryption: true}
  
  connection options
  - encryption: boolean
Returns Promise<void>

database

database(name: string): Database

- Defined in stevesdbclient.ts:230
Alias for getDatabase

Parameters
- name: string
  
  database name
Returns Database

database instance

getDatabase

getDatabase(name: string): Database

- Defined in stevesdbclient.ts:222
Get the database by it's name

Parameters
- name: string
  
  database name
Returns Database

database instance

getDatabaseIfExists

getDatabaseIfExists(name: string): Promise<Database | undefined>

- Defined in stevesdbclient.ts:208
Get the database by it's name if it exists, undefined otherwise

Parameters
- name: string
  
  database name
Returns Promise<Database | undefined>

database instance if it exists, undefined otherwise

getDatabases

getDatabases(): Promise<Database[]>

- Defined in stevesdbclient.ts:193
Get the existing databases

Returns Promise<Database[]>

the list of the databases

getUsername

getUsername(): string | undefined

- Defined in stevesdbclient.ts:177
Get the current user username

Returns string | undefined

user username if the connection is authorized, undefined otherwise

isLoggedIn

isLoggedIn(): boolean

- Defined in stevesdbclient.ts:185
Check whether the connection is authorized

Returns boolean

true, if connection is auhorized

login

login(username: string, password: string): Promise<boolean>

- Defined in stevesdbclient.ts:151
Log in to the database

Parameters
- username: string
  
  user username
- password: string
  
  user password
Returns Promise<boolean>

true, if the login details are correct

logout

logout(): Promise<boolean>

- Defined in stevesdbclient.ts:164
Log out from the database

Returns Promise<boolean>

true, if the connnetion has been successfuly unauthorized

sendPacket

sendPacket(packet: PacketOut): void

- Defined in stevesdbclient.ts:234
Parameters
- packet: PacketOut
Returns void

waitForResponse

waitForResponse<T>(packet: {}): Promise<T>

- Defined in stevesdbclient.ts:242
Type parameters
- T: PacketIn
Parameters
- packet: {}
Returns Promise<T>

Generated using TypeDoc