Skip to content
[ ARKIV ] Docs

selectionToIncludeData

selectionToIncludeData(selection?): RpcIncludeData

Defined in: src/query/selection.ts:77

Converts a SelectArg into the RpcIncludeData understood by the query engine. Every field is opt-in — anything not explicitly selected defaults to false, including the key. undefined or "*" selects everything.

Parameters

Section titled “Parameters”

selection?

Section titled “selection?”

The selection to convert

"*" | Required<Pick<SelectionFields, "key">> & Partial<Omit<SelectionFields, "key">> | Required<Pick<SelectionFields, "contentType">> & Partial<Omit<SelectionFields, "contentType">> | Required<Pick<SelectionFields, "owner">> & Partial<Omit<SelectionFields, "owner">> | Required<Pick<SelectionFields, "creator">> & Partial<Omit<SelectionFields, "creator">> | Required<Pick<SelectionFields, "expiresAtBlock">> & Partial<Omit<SelectionFields, "expiresAtBlock">> | Required<Pick<SelectionFields, "createdAtBlock">> & Partial<Omit<SelectionFields, "createdAtBlock">> | Required<Pick<SelectionFields, "lastModifiedAtBlock">> & Partial<Omit<SelectionFields, "lastModifiedAtBlock">> | Required<Pick<SelectionFields, "transactionIndexInBlock">> & Partial<Omit<SelectionFields, "transactionIndexInBlock">> | Required<Pick<SelectionFields, "operationIndexInTransaction">> & Partial<Omit<SelectionFields, "operationIndexInTransaction">> | Required<Pick<SelectionFields, "attributes">> & Partial<Omit<SelectionFields, "attributes">> | Required<Pick<SelectionFields, "payload">> & Partial<Omit<SelectionFields, "payload">>

Returns

Section titled “Returns”

RpcIncludeData

The fully-resolved include-data object for the RPC query

Throws

Section titled “Throws”

If an empty selection object is provided

Example

Section titled “Example”
selectionToIncludeData() // everything
selectionToIncludeData("*") // everything
selectionToIncludeData({ key: true }) // only the key
selectionToIncludeData({ owner: true }) // only the owner