Interface WeivDataQueryResult<CItem>

interface WeivDataQueryResult<CItem> {
    _filters: any;
    _pipeline?: PipelineStage[];
    currentPage: number;
    items: CItem[];
    length: number;
    pageSize: number;
    totalCount: number;
    totalPages: number;
    hasNext(): boolean;
    hasPrev(): boolean;
    next(): Promise<WeivDataQueryResult<CItem>>;
    prev(): Promise<WeivDataQueryResult<CItem>>;
}

Type Parameters

  • CItem

Properties

_filters _pipeline? currentPage items length pageSize totalCount totalPages

Methods

hasNext hasPrev next prev

Properties

Readonly_filters

_filters: any

Description

Filters applied to query.

Optional Readonly_pipeline

_pipeline?: PipelineStage[]

Description

Pipeline of aggregation if used if not undefined.

ReadonlycurrentPage

currentPage: number

Description

Returns the index of the current results page number.

Readonlyitems

items: CItem[]

Description

Returns the items that match the query.

Readonlylength

length: number

Description

Returns the number of items in the current results page.

ReadonlypageSize

pageSize: number

Description

Returns the query page size.

ReadonlytotalCount

totalCount: number

Description

Returns the total number of items that match the query.

ReadonlytotalPages

totalPages: number

Deprecated

Description

Returns the total number of pages the query produced. (will be deleted in v5 doesn't work correctly)

Methods

hasNext

  • hasNext(): boolean

  • Returns boolean

    Description

    Indicates if the query has more results.

hasPrev

  • hasPrev(): boolean

  • Returns boolean

    Description

    Indicates the query has previous results.

next

prev

Settings

Member Visibility

On This Page

Properties
Methods