adamant-api / api / TransactionQuery

Type Alias: TransactionQuery<T>

type TransactionQuery<T> = Partial<T> & {
  and?: Partial<T>;
  or?: Partial<T>;
};

Defined in: src/api/index.ts:144

A transaction query.

Top-level filter conditions are combined with and by default — every condition must match. This differs from the raw node API, whose default is or. To opt into or, wrap fields in or; an explicit and wrapper is also supported and is equivalent to passing those fields at the top level when no OR filters are present. Mixed operators are flattened in object-key order without parentheses and trigger a runtime warning at most once per client instance.

Control and pagination parameters are not filters. Each endpoint forwards only the controls it supports; known controls from another endpoint are stripped at runtime and warn once per endpoint and parameter.

Type Declaration

and?

optional and?: Partial<T>;

Conditions prefixed with and (the default for top-level fields).

or?

optional or?: Partial<T>;

Conditions prefixed with or; this object does not create parentheses.

Type Parameters

Type Parameter
T extends object

See

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