Type alias RecordsQueryRequest

RecordsQueryRequest: {
    from?: string;
    message: Omit<DwnMessageParams[DwnInterface.RecordsQuery], "signer">;
    protocol?: string;
}

Encapsulates a request to query records from a Decentralized Web Node (DWN).

This request type is used to specify the criteria for querying records, including query parameters, and optionally the target DWN to query from. If the from property is not provided, the query will target the local DWN.

Type declaration

  • Optional from?: string

    Optional DID specifying the remote target DWN tenant to query from and return results.

  • message: Omit<DwnMessageParams[DwnInterface.RecordsQuery], "signer">

    The parameters for the query operation, detailing the criteria for selecting records.

  • Optional protocol?: string

    Records must be scoped to a specific protocol

Settings

Member Visibility

Theme