Class UserPaginatedResults<TColumn, TTable, TRow, TResult>`Abstract`

User Core Paginated Results for iterating and querying through chunks

Type Parameters

TColumn extends UserColumn

column type
TTable extends UserTable<TColumn>

table type
TRow extends UserRow<TColumn, TTable>

row type
TResult extends UserResultSet<TColumn, TTable, TRow>

result type

Hierarchy

UserPaginatedResults
- FeaturePaginatedResults

Implements

IterableIterator<TRow>

Index

Constructors

Methods

[iterator] close getArgs getColumns getDao getPagination getResults getSql ids next setPagination

Constructors

`Protected` constructor

new UserPaginatedResults<TColumn, TTable, TRow, TResult>(dao: UserDao<TColumn, TTable, TRow, TResult>, results: UserResultSet<TColumn, TTable, TRow>): UserPaginatedResults<TColumn, TTable, TRow, TResult>
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
- TTable extends UserTable<TColumn, TTable>
- TRow extends UserRow<TColumn, TTable, TRow>
- TResult extends UserResultSet<TColumn, TTable, TRow, TResult>
Parameters
- dao: UserDao<TColumn, TTable, TRow, TResult>
  
  user core dao
- results: UserResultSet<TColumn, TTable, TRow>
  
  user core results
Returns UserPaginatedResults<TColumn, TTable, TRow, TResult>
- Defined in lib/user/userPaginatedResults.ts:61

Methods

[iterator]

[iterator](): IterableIterator<TRow>
Returns IterableIterator<TRow>
Implementation of IterableIterator.__@iterator@65
- Defined in lib/user/userPaginatedResults.ts:129

close

close(): void
Close the current results

Returns void
- Defined in lib/user/userPaginatedResults.ts:194

getArgs

getArgs(): string[]
Get the SQL arguments

Returns
SQL arguments

Returns string[]
- Defined in lib/user/userPaginatedResults.ts:101

getColumns

getColumns(): string[]
Get the SQL column names

Returns
SQL column names

Returns string[]
- Defined in lib/user/userPaginatedResults.ts:109

getDao

getDao(): UserDao<TColumn, TTable, TRow, TResult>
Get the DAO

Returns
data access object

Returns UserDao<TColumn, TTable, TRow, TResult>
- Defined in lib/user/userPaginatedResults.ts:77

getPagination

getPagination(): Pagination
Get the pagination

Returns
pagination

Returns Pagination
- Defined in lib/user/userPaginatedResults.ts:117

getResults

getResults(): UserResult<TColumn, TTable, TRow>
Get the current paginated results

Returns
current results

Returns UserResult<TColumn, TTable, TRow>
- Defined in lib/user/userPaginatedResults.ts:85

getSql

getSql(): string
Get the initial SQL statement

Returns
SQL statement

Returns string
- Defined in lib/user/userPaginatedResults.ts:93

ids

ids(): IterableIterator<number>
Inherit Doc

Returns IterableIterator<number>
- Defined in lib/user/userPaginatedResults.ts:181

next

next(): {
done: boolean;
value: TRow;
}
Returns {
done: boolean;
value: TRow;
}
- done: boolean
- value: TRow
Implementation of IterableIterator.next
- Defined in lib/user/userPaginatedResults.ts:156

setPagination

setPagination(pagination: Pagination): void
Set the pagination
Parameters
- pagination: Pagination
  
  pagination
Returns void
- Defined in lib/user/userPaginatedResults.ts:125

Generated using TypeDoc