Type alias RecordsReadRequest

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

Represents a request to read a specific record from a Decentralized Web Node (DWN).

This request type is used to specify the target DWN from which the record should be read and any additional parameters for the read operation. It's useful for fetching the details of a single record by its identifier or other criteria.

Type declaration

  • Optional from?: string

    Optional DID specifying the remote target DWN tenant the record will be read from.

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

    The parameters for the read operation, detailing the criteria for selecting the record.

  • Optional protocol?: string

    Records must be scoped to a specific protocol

Settings

Member Visibility

Theme