Class QuickDB<D>

Type Parameters

D = any

Hierarchy

QuickDB

Index

Constructors

Properties

_driver normalKeys options prepared tableName instance

Accessors

Methods

add addSubtract all delete deleteAll get getArray has init pop pull push set shift startsWith sub table tableAsync unshift useNormalKeys createSingleton

Constructors

constructor

new QuickDB<D>(options?: IQuickDBOptions): QuickDB<D>
Type Parameters
- D = any
Parameters
- options: IQuickDBOptions = {}
Returns QuickDB<D>
- Defined in index.ts:31

Properties

`Private` _driver

_driver: IDriver

`Private` normalKeys

normalKeys: boolean

`Private` options

options: IQuickDBOptions

`Private` prepared

prepared: Promise<unknown>

`Private` tableName

tableName: string

`Static` `Private` instance

instance: QuickDB<any>

Accessors

driver

get driver(): IDriver
Returns IDriver
- Defined in index.ts:27

Methods

add

add(key: string, value: number): Promise<number>
Parameters
- key: string
- value: number
Returns Promise<number>
- Defined in index.ts:183

`Private` addSubtract

addSubtract(key: string, value: number, sub?: boolean): Promise<number>
Parameters
- key: string
- value: number
- sub: boolean = false
Returns Promise<number>
- Defined in index.ts:45

all

all<T>(): Promise<{
id: string;
value: T;
}[]>
Type Parameters
- T = D
Returns Promise<{
id: string;
value: T;
}[]>
- Defined in index.ts:104

delete

delete(key: string): Promise<number>
Parameters
- key: string
Returns Promise<number>
- Defined in index.ts:165

deleteAll

deleteAll(): Promise<number>
Returns Promise<number>
- Defined in index.ts:179

get

get<T>(key: string): Promise<null | T>
Type Parameters
- T = D
Parameters
- key: string
Returns Promise<null | T>
- Defined in index.ts:108

`Private` getArray

getArray<T>(key: string): Promise<T[]>
Type Parameters
- T = D
Parameters
- key: string
Returns Promise<T[]>
- Defined in index.ts:83

has

has(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
- Defined in index.ts:161

init

init(): Promise<void>
Returns Promise<void>
- Defined in index.ts:99

pop

pop<T>(key: string): Promise<undefined | T>
Type Parameters
- T = D
Parameters
- key: string
Returns Promise<undefined | T>
- Defined in index.ts:215

pull

pull<T>(key: string, value: T | T[] | ((data: T, index: string) => boolean), once?: boolean): Promise<T[]>
Type Parameters
- T = D
Parameters
- key: string
- value: T | T[] | ((data: T, index: string) => boolean)
- once: boolean = false
Returns Promise<T[]>
- Defined in index.ts:239

push

push<T>(key: string, ...values: T[]): Promise<T[]>
Type Parameters
- T = D
Parameters
- key: string
- Rest ...values: T[]
Returns Promise<T[]>
- Defined in index.ts:191

set

set<T>(key: string, value: T): Promise<T>
Type Parameters
- T = D
Parameters
- key: string
- value: T
Returns Promise<T>
- Defined in index.ts:125

shift

shift<T>(key: string): Promise<undefined | T>
Type Parameters
- T = D
Parameters
- key: string
Returns Promise<undefined | T>
- Defined in index.ts:227

startsWith

startsWith<T>(query: string, key?: string): Promise<{
id: string;
value: T;
}[]>
Type Parameters
- T = D
Parameters
- query: string
- key: string = ""
Returns Promise<{
id: string;
value: T;
}[]>
- Defined in index.ts:267

sub

sub(key: string, value: number): Promise<number>
Parameters
- key: string
- value: number
Returns Promise<number>
- Defined in index.ts:187

table

table<T>(table: string): QuickDB<T>
Type Parameters
- T = D
Parameters
- table: string
Returns QuickDB<T>
- Defined in index.ts:287

tableAsync

tableAsync(table: string): Promise<QuickDB<any>>
Parameters
- table: string
Returns Promise<QuickDB<any>>
- Defined in index.ts:299

unshift

unshift<T>(key: string, value: T | T[]): Promise<T[]>
Type Parameters
- T = D
Parameters
- key: string
- value: T | T[]
Returns Promise<T[]>
- Defined in index.ts:203

useNormalKeys

useNormalKeys(activate: boolean): void
Parameters
- activate: boolean
Returns void
- Defined in index.ts:306

`Static` createSingleton

createSingleton<T>(options?: IQuickDBOptions): QuickDB<T>
Type Parameters
- T
Parameters
- options: IQuickDBOptions = {}
Returns QuickDB<T>
- Defined in index.ts:92

Generated using TypeDoc