Type alias RecordsDeleteRequest

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

Defines a request to delete a record from the Decentralized Web Node (DWN).

This request type optionally specifies the target from which the record should be deleted and the message parameters for the delete operation. If the from property is not provided, the record will be deleted from the local DWN.

Type declaration

  • Optional from?: string

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

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

    The parameters for the delete operation.

  • Optional protocol?: string

    Records must be scoped to a specific protocol

Settings

Member Visibility

Theme