Class Pskv

Hierarchy

Pskv

Index

Constructors

Methods

clear connect delete end get has set

Constructors

constructor

new Pskv(options: PskvInitOptions): Pskv
Parameters
- options: PskvInitOptions
Returns Pskv
- Defined in lib.ts:7

Methods

clear

clear(): Promise<ResultIterator>
Clears the Store WARNING This is dangerous

Returns

Returns Promise<ResultIterator>
- Defined in lib.ts:83

connect

connect(): Promise<ResultIterator>
Connects client to DB and performs table creation if needed

Returns
- The result of table creation
Returns Promise<ResultIterator>
- Defined in lib.ts:19

delete

delete(key: string): Promise<ResultIterator>
Deletes a Store in table

Returns
Parameters
- key: string
  
  {string} - Key to delete
Returns Promise<ResultIterator>
- Defined in lib.ts:72

end

end(): Promise<void>
Ends DB connection

Returns Promise<void>
- Defined in lib.ts:89

get

get<T>(key: string): Promise<T>
Gets a value from Store

Returns
- The result of Query
Type Parameters
- T
  
  Type of the returned value
Parameters
- key: string
  
  {string} - Name of the key to get
Returns Promise<T>
- Defined in lib.ts:35

has

has(key: string): Promise<boolean>
Check if Store contains key

Returns
Parameters
- key: string
  
  {string} - Key to check
Returns Promise<boolean>
- Defined in lib.ts:64

set

set(key: string, value: unknown): Promise<ResultIterator>
Set value in Store

Returns
- Result of the query
Parameters
- key: string
  
  {string} - Key
- value: unknown
  
  {unknown} - Value (MUST be serialisable by JSON.stringify or be a Buffer)
Returns Promise<ResultIterator>
- Defined in lib.ts:51

Generated using TypeDoc