Interface DidResolver<Accept>

The resolve function returns the DID document in its abstract form (a map).

Type Parameters

Accept extends string = string

Hierarchy

ResolveDid<Accept>
DereferenceDidUrl<Accept>
- DidResolver

Index

Properties

dereference resolve resolveRepresentation

Properties

dereference

dereference: ((didUrl, dereferenceOptions?) => Promise<DereferenceResult<Accept>>)

Type declaration

- (didUrl, dereferenceOptions?): Promise<DereferenceResult<Accept>>
- Parameters
  - didUrl: Did | DidUrl
    
    A conformant DID URL as a single string. This is the DID URL to dereference. To dereference a DID fragment, the complete DID URL including the DID fragment MUST be used. This input is REQUIRED.
  - Optional dereferenceOptions: DereferenceOptions<Accept>
    
    A metadata structure consisting of input options to the dereference function in addition to the didUrl itself. Properties defined by this specification are in 7.2.1 DID URL Dereferencing Options. This input is REQUIRED, but the structure MAY be empty.
  Returns Promise<DereferenceResult<Accept>>

resolve

resolve: ((did, resolutionOptions?) => Promise<ResolutionResult>)

Type declaration

- (did, resolutionOptions?): Promise<ResolutionResult>
- Parameters
  - did: Did
    
    This is the DID to resolve. This input is REQUIRED and the value MUST be a conformant DID as defined in 3.1 DID Syntax.
  - Optional resolutionOptions: ResolutionOptions
    
    A metadata structure containing properties defined in 7.1.1 DID Resolution Options. This input is REQUIRED, but the structure MAY be empty.
  Returns Promise<ResolutionResult>

resolveRepresentation

resolveRepresentation: ((did, resolutionOptions?) => Promise<RepresentationResolutionResult<Accept>>)

Type declaration

- (did, resolutionOptions?): Promise<RepresentationResolutionResult<Accept>>
- Parameters
  - did: Did
    
    This is the DID to resolve. This input is REQUIRED and the value MUST be a conformant DID as defined in 3.1 DID Syntax.
  - Optional resolutionOptions: RepresentationResolutionOptions<Accept>
    
    A metadata structure containing properties defined in 7.1.1 DID Resolution Options. This input is REQUIRED, but the structure MAY be empty.
  Returns Promise<RepresentationResolutionResult<Accept>>