Skip to main content
Version: 1.18.x

QueryOptions

Defined in: messages/QueryEntry.ts:38

Options for querying records

Constructors​

Constructor​

> new QueryOptions(): QueryOptions

Returns​

QueryOptions

Properties​

continuous?​

> optional continuous: boolean

Defined in: messages/QueryEntry.ts:55

Don't stop query until TTL is reached

eachN?​

> optional eachN: number

Defined in: messages/QueryEntry.ts:48

Return only one record per N records @deprecated: use $each_n operator in when instead. Will be remove in v1.18.0

eachS?​

> optional eachS: number

Defined in: messages/QueryEntry.ts:44

Return only one record per S second @deprecated: use $each_t operator in when instead. Will be remove in v1.18.0

ext?​

> optional ext: Record<string, any>

Defined in: messages/QueryEntry.ts:65

Additional parameters for extensions

> optional head: boolean

Defined in: messages/QueryEntry.ts:59

Return only metadata

limit?​

> optional limit: number

Defined in: messages/QueryEntry.ts:52

Limit number of records @deprecated: use $limit operator in when instead. Will be remove in v1.18.0

pollInterval?​

> optional pollInterval: number

Defined in: messages/QueryEntry.ts:57

Poll interval for new records only for continue=true

strict?​

> optional strict: boolean

Defined in: messages/QueryEntry.ts:63

strict conditional query

ttl?​

> optional ttl: number

Defined in: messages/QueryEntry.ts:40

Time to live in seconds

when?​

> optional when: Record<string, any>

Defined in: messages/QueryEntry.ts:61

Conditional query

Methods​

serialize()​

> static serialize(queryType, data, start?, stop?, entries?): QueryEntry

Defined in: messages/QueryEntry.ts:67

Parameters​

queryType​

QueryType

data​

QueryOptions

start?​

bigint

stop?​

bigint

entries?​

string[]

Returns​

QueryEntry