Page Class
Package: @esfx/iter-page
Declaration
export declare class Page<T> implements Iterable<T>
Constructors
constructor(page, offset, values)
Constructs a new instance of the Page
class
Declaration
constructor(page: number, offset: number, values: Iterable<T>);
Parameters
- page
- number
- offset
- number
- values
- Iterable<T>
Properties
offset
The element offset from the start of the source iterable.
Declaration
readonly offset: number;
Property Value
page
The page offset from the start of the source iterable.
Declaration
readonly page: number;
Property Value
values
The values associated with this page.
Declaration
readonly values: Iterable<T>;
Property Value
Iterable<T>
Methods
[Symbol.iterator]()
Declaration
[Symbol.iterator](): Iterator<T, any, undefined>;
Returns
Iterator<T, any, undefined>
from(page, offset, values, provider)
Declaration
static from<TNode, T extends TNode>(page: number, offset: number, values: Iterable<T>, provider: HierarchyProvider<TNode>): HierarchyPage<TNode, T>;
Type Parameters
- TNode
- T
Parameters
- page
- number
- offset
- number
- values
- Iterable<T>
- provider
- HierarchyProvider<TNode>
Returns
HierarchyPage<TNode, T>
from(page, offset, values)
Declaration
static from<TNode, T extends TNode>(page: number, offset: number, values: HierarchyIterable<TNode, T>): HierarchyPage<TNode, T>;
Type Parameters
- TNode
- T
Parameters
- page
- number
- offset
- number
- values
- HierarchyIterable<TNode, T>
Returns
HierarchyPage<TNode, T>
from(page, offset, values)
Declaration
static from<T>(page: number, offset: number, values: Iterable<T>): Page<T>;
Type Parameters
- T
Parameters
- page
- number
- offset
- number
- values
- Iterable<T>
Returns
Page<T>