Class FeaturePaginatedResults

Feature Paginated Results for iterating and querying through features in chunks

Hierarchy

UserPaginatedResults<FeatureColumn, FeatureTable, FeatureRow, FeatureResultSet>
- FeaturePaginatedResults

Index

Constructors

Methods

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

Constructors

constructor

new FeaturePaginatedResults(dao: FeatureDao, results: FeatureResultSet): FeaturePaginatedResults
Constructor
Parameters
- dao: FeatureDao
  
  feature dao
- results: FeatureResultSet
  
  feature result set
Returns FeaturePaginatedResults
Overrides UserPaginatedResults.constructor
- Defined in lib/features/user/featurePaginatedResults.ts:51

Methods

[iterator]

[iterator](): IterableIterator<FeatureRow>
Returns IterableIterator<FeatureRow>
Inherited from UserPaginatedResults.[iterator]
- Defined in lib/user/userPaginatedResults.ts:129

close

close(): void
Close the current results

Returns void
Inherited from UserPaginatedResults.close
- Defined in lib/user/userPaginatedResults.ts:194

getArgs

getArgs(): string[]
Get the SQL arguments

Returns
SQL arguments

Returns string[]
Inherited from UserPaginatedResults.getArgs
- Defined in lib/user/userPaginatedResults.ts:101

getColumns

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

Returns
SQL column names

Returns string[]
Inherited from UserPaginatedResults.getColumns
- Defined in lib/user/userPaginatedResults.ts:109

getDao

getDao(): FeatureDao
Get the DAO

Returns
data access object

Returns FeatureDao
Overrides UserPaginatedResults.getDao
- Defined in lib/features/user/featurePaginatedResults.ts:58

getPagination

getPagination(): Pagination
Get the pagination

Returns
pagination

Returns Pagination
Inherited from UserPaginatedResults.getPagination
- Defined in lib/user/userPaginatedResults.ts:117

getResults

getResults(): FeatureResultSet
Get the current paginated results

Returns
current results

Returns FeatureResultSet
Overrides UserPaginatedResults.getResults
- Defined in lib/features/user/featurePaginatedResults.ts:65

getSql

getSql(): string
Get the initial SQL statement

Returns
SQL statement

Returns string
Inherited from UserPaginatedResults.getSql
- Defined in lib/user/userPaginatedResults.ts:93

ids

ids(): IterableIterator<number>
Inherit Doc

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

next

next(): {
done: boolean;
value: FeatureRow;
}
Returns {
done: boolean;
value: FeatureRow;
}
- done: boolean
- value: FeatureRow
Inherited from UserPaginatedResults.next
- Defined in lib/user/userPaginatedResults.ts:156

setPagination

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

`Static` create

create(dao: FeatureDao, results: FeatureResultSet): FeaturePaginatedResults
Create paginated results

Returns
feature paginated results
Parameters
- dao: FeatureDao
  
  feature dao
- results: FeatureResultSet
  
  feature result set
Returns FeaturePaginatedResults
- Defined in lib/features/user/featurePaginatedResults.ts:42

`Static` getPagination

getPagination(resultSet: FeatureResultSet): Pagination
Get the pagination offset and limit

Returns
pagination or null if not paginated
Parameters
- resultSet: FeatureResultSet
  
  feature result set
Returns Pagination
- Defined in lib/features/user/featurePaginatedResults.ts:32

`Static` isPaginated

isPaginated(resultSet: FeatureResultSet): boolean
Determine if the result set is paginated

Returns
true if paginated
Parameters
- resultSet: FeatureResultSet
  
  feature result set
Returns boolean
- Defined in lib/features/user/featurePaginatedResults.ts:23

Generated using TypeDoc