Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryParameters

label

COMMON

interface

QueryParameters

description

This interface configures simple database queries that can be paginated and sorted. A query may use the id field to match individual documents.

see

Queryable

since

@v0.2.0

Hierarchy

Implemented by

Index

Properties

order: string

A query's order mode. This determines the direction of sorting for search results.

pageNumber: number

A query's page number. This determines the offset of search results.

pageSize: number

A query's page size. This determines the number of items a search result will contain.

sort: string

A query's sort column. This determines which column of a document is used to sort search results.

Generated using TypeDoc