Class DidApi`Beta`

The DID API is used to resolve DIDs.

Index

Constructors

Properties

agent connectedDid

Methods

Constructors

constructor

new DidApi(options): DidApi
Parameters
- options: {
  agent: Web5Agent;
  connectedDid: string;
  }
  - agent: Web5Agent
  - connectedDid: string
Returns DidApi

Properties

`Private` agent

agent: Web5Agent

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

`Private` connectedDid

connectedDid: string

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

Methods

create

create(request): Promise<DidCreateResponse>
Initiates the creation of a Decentralized Identifier (DID) using the specified method, options, and storage preference.

This method sends a request to the Web5 Agent to create a new DID based on the provided method, with method-specific options. It also specifies whether the newly created DID should be stored.
Parameters
- request: DidCreateRequest
  The request parameters for creating a DID, including the method, options, and storage flag.
Returns Promise<DidCreateResponse>
A promise that resolves to a DidCreateResponse, which includes the operation's status and, if successful, the newly created DID.

resolve

resolve(didUri, options?): Promise<DidResolutionResult>
Resolves a DID to a DID Resolution Result.
Parameters
- didUri: string
  The DID or DID URL to resolve.
- Optional options: DidResolutionOptions
Returns Promise<DidResolutionResult>
A promise that resolves to the DID Resolution Result.