Query | redux-database

Type parameters

State: StateDefining
TableKey: RowKeyOf<State>
T: Row

Hierarchy

Query

Index

Constructors

constructor

Properties

db
table

Accessors

Methods

Constructors

constructor

new Query(db: DB<State>, table: Table<T>): Query

- Defined in query.ts:19
Parameters
- db: DB<State>
- table: Table<T>
Returns Query

Properties

Private db

db: DB<State>

Private table

table: Table<T>

Accessors

all

get all(): T[]

- Defined in query.ts:37
Returns T[]

first

get first(): T | undefined

- Defined in query.ts:25
Returns T | undefined

last

get last(): T | undefined

- Defined in query.ts:29
Returns T | undefined

length

get length(): number

- Defined in query.ts:41
Returns number

Methods

embed

embed<Key, SecondaryTable, JoinKey, Embed>(key: Key, table: SecondaryTable, source: JoinKey): Query<State, TableKey, T & Record<Key, undefined extends T[JoinKey] ? Embed | undefined : Embed>>

- Defined in query.ts:78
Type parameters
- Key: string
- SecondaryTable: RowKeyOf<State>
- JoinKey: keyof T
- Embed
Parameters
- key: Key
- table: SecondaryTable
- source: JoinKey
Returns Query<State, TableKey, T & Record<Key, undefined extends T[JoinKey] ? Embed | undefined : Embed>>

embedMulti

embedMulti<Key, SecondaryTable, JoinKey, Embed>(key: Key, table: SecondaryTable, source: JoinKey): Query<State, TableKey, T & Record<Key, Embed[]>>

- Defined in query.ts:105
Type parameters
- Key: string
- SecondaryTable: RowKeyOf<State>
- JoinKey: keyof T
- Embed
Parameters
- key: Key
- table: SecondaryTable
- source: JoinKey
Returns Query<State, TableKey, T & Record<Key, Embed[]>>

find

find(id: string): T | undefined

- Defined in query.ts:33
Parameters
- id: string
Returns T | undefined

limit

limit(amount: number): Query<State, TableKey, T>

- Defined in query.ts:63
Parameters
- amount: number
Returns Query<State, TableKey, T>

offset

offset(amount: number): Query<State, TableKey, T>

- Defined in query.ts:68
Parameters
- amount: number
Returns Query<State, TableKey, T>

orderBy

orderBy(sortDescriptor: SortDescriptor<T>): Query<State, TableKey, T>

- Defined in query.ts:73
Parameters
- sortDescriptor: SortDescriptor<T>
Returns Query<State, TableKey, T>

Private queryFromResults

queryFromResults<ResultType>(results: ResultType[]): Query<State, TableKey, ResultType>

- Defined in query.ts:127
Type parameters
- ResultType: Row
Parameters
- results: ResultType[]
Returns Query<State, TableKey, ResultType>

select

select<K>(...fields: K[]): Query<State, TableKey, Pick<T, K> & Row>

- Defined in query.ts:45
Type parameters
- K: keyof T
Parameters
- Rest ...fields: K[]
Returns Query<State, TableKey, Pick<T, K> & Row>

where

where(query: ((value: T) => boolean) | Partial<T>): Query<State, TableKey, T>

- Defined in query.ts:56
Parameters
- query: ((value: T) => boolean) | Partial<T>
Returns Query<State, TableKey, T>

Generated using TypeDoc