Class DataFinder<T, PK_Type>

Data finder

Type Parameters

T
PK_Type = GenericKeyValue

Hierarchy

DataFinder

Index

Constructors

constructor

new DataFinder<T, PK_Type>(source: string, table: string, key: ModelKeyName<T>, dataParse: ((data: TypedRow<T>) => T)): DataFinder<T, PK_Type>
Constructor
Type Parameters
- T
- PK_Type = any
Parameters
- source: string
  
  Name of the source
- table: string
  
  Name of the table
- key: ModelKeyName<T>
  
  Name of the primary key
- dataParse: ((data: TypedRow<T>) => T)
  
  Function to create DatModel from GenericRow
  - - (data: TypedRow<T>): T
    - Parameters
      
      data: TypedRow<T>
      
      Returns T
Returns DataFinder<T, PK_Type>
- Defined in finder.ts:368

Properties

`Private` dataParse

dataParse: ((data: TypedRow<T>) => T)

Type declaration

- (data: TypedRow<T>): T
- Parameters
  - data: TypedRow<T>
  Returns T

`Private` key

key: ModelKeyName<T>

`Private` source

source: string

`Private` table

table: string

Methods

count

count(where: DataFilter<T>, queryExtraOptions?: QueryExtraOptions): Promise<number>
Counts instances
Parameters
- where: DataFilter<T>
  
  Conditions for the instances to match
- Optional queryExtraOptions: QueryExtraOptions
Returns Promise<number>
- Defined in finder.ts:440

delete

delete(where: DataFilter<T>): Promise<number>
Delete instances
Parameters
- where: DataFilter<T>
  
  Conditions for the instances to match
Returns Promise<number>
- Defined in finder.ts:457

find

find(where: DataFilter<T>, orderBy?: OrderBy<T>, options?: SelectOptions<T>): Promise<T[]>
Find instances
Parameters
- where: DataFilter<T>
  
  Conditions for the instances to match
- Optional orderBy: OrderBy<T>
  
  Order of the results
- Optional options: SelectOptions<T>
  
  Additional options
Returns Promise<T[]>
- Defined in finder.ts:394

findByKey

findByKey(keyValue: PK_Type): Promise<T>
Find instance by key
Parameters
- keyValue: PK_Type
  
  The value of the primary key
Returns Promise<T>
- Defined in finder.ts:379

findStream

findStream(where: DataFilter<T>, orderBy: OrderBy<T>, options: SelectOptions<T>, each: ((row: T) => Promise<void>)): Promise<void>
Find instances (stream) / Async callback
Parameters
- where: DataFilter<T>
  
  Conditions for the instances to match
- orderBy: OrderBy<T>
  
  Order of the results
- options: SelectOptions<T>
  
  Additional options
- each: ((row: T) => Promise<void>)
  
  Callback for each row
  - - (row: T): Promise<void>
    - Parameters
      
      row: T
      
      Returns Promise<void>
Returns Promise<void>
- Defined in finder.ts:416

findStreamSync

findStreamSync(where: DataFilter<T>, orderBy: OrderBy<T>, options: SelectOptions<T>, each: ((row: T) => void)): Promise<void>
Find instances (stream) / Sync callback
Parameters
- where: DataFilter<T>
  
  Conditions for the instances to match
- orderBy: OrderBy<T>
  
  Order of the results
- options: SelectOptions<T>
  
  Additional options
- each: ((row: T) => void)
  
  Callback for each row
  - - (row: T): void
    - Parameters
      
      row: T
      
      Returns void
Returns Promise<void>
- Defined in finder.ts:429

sum

sum(field: ModelKeyName<T>, where: DataFilter<T>): Promise<number>
Summation for instances
Parameters
- field: ModelKeyName<T>
  
  Field to compute summation
- where: DataFilter<T>
  
  Conditions for the instances to match
Returns Promise<number>
- Defined in finder.ts:449

update

update(set: StrictRowUpdate<T>, where: DataFilter<T>): Promise<number>
Update instances
Parameters
- set: StrictRowUpdate<T>
  
  Changes to make
- where: DataFilter<T>
  
  Conditions for the instances to match
Returns Promise<number>
- Defined in finder.ts:466

Class DataFinder<T, PK_Type>

Type Parameters

T

PK_Type = GenericKeyValue

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

PK_Type = any

Parameters

source: string

table: string

key: ModelKeyName<T>

dataParse: ((data: TypedRow<T>) => T)

Parameters

data: TypedRow<T>

Returns T

Returns DataFinder<T, PK_Type>

Properties

Private dataParse

Type declaration

Parameters

data: TypedRow<T>

Returns T

Private key

Private source

Private table

Methods

count

Parameters

where: DataFilter<T>

Optional queryExtraOptions: QueryExtraOptions

Returns Promise<number>

delete

Parameters

where: DataFilter<T>

Returns Promise<number>

find

Parameters

where: DataFilter<T>

Optional orderBy: OrderBy<T>

Optional options: SelectOptions<T>

Returns Promise<T[]>

findByKey

Parameters

keyValue: PK_Type

Returns Promise<T>

findStream

Parameters

where: DataFilter<T>

orderBy: OrderBy<T>

options: SelectOptions<T>

each: ((row: T) => Promise<void>)

Parameters

row: T

Returns Promise<void>

Returns Promise<void>

findStreamSync

Parameters

where: DataFilter<T>

orderBy: OrderBy<T>

options: SelectOptions<T>

each: ((row: T) => void)

Parameters

row: T

Returns void

Returns Promise<void>

sum

Parameters

field: ModelKeyName<T>

where: DataFilter<T>

Returns Promise<number>

update

Parameters

set: StrictRowUpdate<T>

`Private` dataParse

`Private` key

`Private` source

`Private` table

`Optional` queryExtraOptions: QueryExtraOptions

`Optional` orderBy: OrderBy<T>

`Optional` options: SelectOptions<T>