Class DwnApi

Interface to interact with DWN Records and Protocols

Constructors

constructor

Properties

agent connectedDid

Accessors

protocols records

Constructors

constructor

  • new DwnApi(options): DwnApi

  • Parameters

    • options: {
          agent: Web5Agent;
          connectedDid: string;
      }
      • agent: Web5Agent
      • connectedDid: string

    Returns DwnApi

Properties

Private agent

agent: Web5Agent

Holds the instance of a Web5Agent that represents the current execution context for the DwnApi. This agent is used to process DWN requests.

Private connectedDid

connectedDid: string

The DID of the DWN tenant under which operations are being performed.

Accessors

protocols

records

  • get records(): {
        create: ((request) => Promise<RecordsWriteResponse>);
        createFrom: ((request) => Promise<RecordsWriteResponse>);
        delete: ((request) => Promise<DwnResponseStatus>);
        query: ((request) => Promise<RecordsQueryResponse>);
        read: ((request) => Promise<RecordsReadResponse>);
        write: ((request) => Promise<RecordsWriteResponse>);
    }

  • API to interact with DWN records (e.g., dwn.records.create()).

    Returns {
        create: ((request) => Promise<RecordsWriteResponse>);
        createFrom: ((request) => Promise<RecordsWriteResponse>);
        delete: ((request) => Promise<DwnResponseStatus>);
        query: ((request) => Promise<RecordsQueryResponse>);
        read: ((request) => Promise<RecordsReadResponse>);
        write: ((request) => Promise<RecordsWriteResponse>);
    }

    • create: ((request) => Promise<RecordsWriteResponse>)

      Alias for the write method

    • createFrom: ((request) => Promise<RecordsWriteResponse>)

      Write a record based on an existing one (useful for updating an existing record)

    • delete: ((request) => Promise<DwnResponseStatus>)

      Delete a record

        • (request): Promise<DwnResponseStatus>

        • Delete a record

          Parameters

          Returns Promise<DwnResponseStatus>

    • query: ((request) => Promise<RecordsQueryResponse>)

      Query a single or multiple records based on the given filter

    • read: ((request) => Promise<RecordsReadResponse>)

      Read a single record based on the given filter

    • write: ((request) => Promise<RecordsWriteResponse>)

      Writes a record to the DWN

      As a convenience, the Record instance returned will cache a copy of the data. This is done to maintain consistency with other DWN methods, like RecordsQuery, that include relatively small data payloads when returning RecordsWrite message properties. Regardless of data size, methods such as record.data.stream() will return the data when called even if it requires fetching from the DWN datastore.

        • (request): Promise<RecordsWriteResponse>

        • Writes a record to the DWN

          As a convenience, the Record instance returned will cache a copy of the data. This is done to maintain consistency with other DWN methods, like RecordsQuery, that include relatively small data payloads when returning RecordsWrite message properties. Regardless of data size, methods such as record.data.stream() will return the data when called even if it requires fetching from the DWN datastore.

          Parameters

          Returns Promise<RecordsWriteResponse>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc