Skip to main content

Class: Dataset<T>

Defined in: ts/src/dataset.ts:18

Type Parameters​

T​

T extends object

Constructors​

Constructor​

new Dataset<T>(rows): Dataset<T>

Defined in: ts/src/dataset.ts:22

Parameters​

rows​

readonly T[]

Returns​

Dataset<T>

Accessors​

size​

Get Signature​

get size(): number

Defined in: ts/src/dataset.ts:28

Number of rows held.

Returns​

number

Methods​

filter()​

filter(specs): T[]

Defined in: ts/src/dataset.ts:33

Rows matching the filter specs (pypaginate's exact semantics).

Parameters​

specs​

readonly FilterSpec[]

Returns​

T[]

page()​

page(params, opts?): OffsetPage<T>

Defined in: ts/src/dataset.ts:75

Filter + search + sort + offset-paginate in ONE native call. search is a match-filter (keep rows matching the query); an explicit sorting still decides the order, and the resident trigram index prunes fuzzy candidates.

Parameters​

params​

OffsetParams

opts?​
filters?​

readonly FilterSpec[]

SearchSpec

sorting?​

readonly SortSpec[]

Returns​

OffsetPage<T>

search()​

search(spec): T[]

Defined in: ts/src/dataset.ts:51

Rows ranked by relevance of the search spec's query over its fields.

Parameters​

spec​

SearchSpec

Returns​

T[]

sort()​

sort(specs): T[]

Defined in: ts/src/dataset.ts:42

Rows sorted by the specs (null-aware, stable).

Parameters​

specs​

readonly SortSpec[]

Returns​

T[]