Skip to content

adamant-api / index / transformTransactionQuery

Function: transformTransactionQuery()

ts
function transformTransactionQuery<T>(obj?): Record<string, unknown>;

Defined in: src/api/utils.ts:51

Serializes a transaction query into the flat shape the node expects.

Top-level filter conditions are combined with and by default: each is emitted with an and: prefix. This differs from the raw node API, whose default is or. To opt into or semantics, wrap fields in or: { ... }; the explicit and: { ... } wrapper is also still supported (and equivalent to passing those fields at the top level).

Control and pagination parameters (limit, offset, orderBy, returnAsset, returnUnconfirmed, the direct-transfer flags, and userId) are not filters and are passed through unchanged.

Type Parameters

Type Parameter
T extends object

Parameters

ParameterType
obj?TransactionQuery<T>

Returns

Record<string, unknown>

See

https://docs.adamant.im/api/transactions-query-language.html#combine-filters-and-options

Released under the GPL-3.0 License.