Class Query

Query Class to handle

Index

Constructors

Methods

attachment encoding key_expr parameters payload reply reply_del reply_err selector toString

Constructors

constructor

new Query(query_id, key_expr, parameters, payload, attachment, encoding, reply_tx): Query
New Function Used to Construct Query, Note: Users should not need to call this function But will receieve 'Query's from Queryables
Parameters
- query_id: UUIDv4
- key_expr: KeyExpr
- parameters: Parameters
- payload: undefined | ZBytes
- attachment: undefined | ZBytes
- encoding: undefined | Encoding
- reply_tx: SimpleChannel<QueryReplyWS>
Returns Query
- Defined in src/query.ts:212

Methods

attachment

attachment(): undefined | ZBytes
gets the Optional Attachment of a Query

Returns undefined | ZBytes
ZBytes | undefined
- Defined in src/query.ts:269

encoding

encoding(): undefined | Encoding
gets the Optional Encoding of a Query

Returns undefined | Encoding
Encoding | undefined
- Defined in src/query.ts:262

key_expr

key_expr(): KeyExpr
gets the KeyExpr of Query

Returns KeyExpr
KeyExpr
- Defined in src/query.ts:241

parameters

parameters(): Parameters
gets the Parameters of Query

Returns Parameters
Parameters
- Defined in src/query.ts:248

payload

payload(): undefined | ZBytes
gets the Optioanl payload of Query

Returns undefined | ZBytes
ZBytes | undefined
- Defined in src/query.ts:255

reply

reply(key_expr, payload, options?): void
Sends a Reply to for Query
Parameters
- key_expr: IntoKeyExpr
- payload: IntoZBytes
- Optionaloptions: ReplyOptions
Returns void
void
- Defined in src/query.ts:289

reply_del

reply_del(key_expr, options?): void
Sends an Error Reply to a query
Parameters
- key_expr: IntoKeyExpr
  IntoKeyExpr
- Optionaloptions: ReplyDelOptions
Returns void
void
- Defined in src/query.ts:333

reply_err

reply_err(payload, options?): void
Sends an Error Reply to a query
Parameters
- payload: IntoZBytes
- Optionaloptions: ReplyErrOptions
Returns void
void
- Defined in src/query.ts:316

selector

selector(): Selector
gets an selector of Query

Returns Selector
Selector
- Defined in src/query.ts:234

toString

toString(): string
Returns string
- Defined in src/query.ts:352