Class ZPageBuilder<T>

A builder for a page object.

Type Parameters

T = unknown

Index

Constructors

Methods

all build copy count data empty singleton

Constructors

constructor

new ZPageBuilder<T = unknown>(): ZPageBuilder<T>
Initializes a new instance of this object.
Type Parameters
- T = unknown
Returns ZPageBuilder<T>
- Defined in packages/helpful-query/src/page/page.mts:27

Methods

all

all<D>(data: D[]): ZPageBuilder<D>
Creates a page of data where the data represents the entire data set.
Type Parameters
- D
Parameters
- data: D[]
  The entire data set.
Returns ZPageBuilder<D>
This object.
- Defined in packages/helpful-query/src/page/page.mts:66

build

build(): IZPage<T>
Returns the built page.

Returns IZPage<T>
The built page.
- Defined in packages/helpful-query/src/page/page.mts:121

copy

copy(other: IZPage<T>): ZPageBuilder<T>
Copies another page object into this page builder.
Parameters
- other: IZPage<T>
  The page to copy.
Returns ZPageBuilder<T>
This object.
- Defined in packages/helpful-query/src/page/page.mts:109

count

count(count: number): ZPageBuilder<T>
Sets the total item count across all pages.
Parameters
- count: number
  The total item count across all pages.
Returns ZPageBuilder<T>
This object.
- Defined in packages/helpful-query/src/page/page.mts:95

data

data<D>(data: D[]): ZPageBuilder<D>
Sets the page view.
Type Parameters
- D
Parameters
- data: D[]
  The view of the data on the given page.
Returns ZPageBuilder<D>
This object.
- Defined in packages/helpful-query/src/page/page.mts:79

empty

empty(): ZPageBuilder<never>
Sets the count to 0 and the data to the empty array.

Returns ZPageBuilder<never>
This object.
- Defined in packages/helpful-query/src/page/page.mts:40

singleton

singleton<D>(item: D): ZPageBuilder<D>
Creates a page of data that has only one item, and it represents the entire data set.
Type Parameters
- D
Parameters
- item: D
  The only item in the data set.
Returns ZPageBuilder<D>
This object.
- Defined in packages/helpful-query/src/page/page.mts:53