Type alias DidResolutionMetadata

DidResolutionMetadata: {
    contentType?: string;
    error?: string;
    [key: string]: any;
}

Represents metadata related to the result of a DID resolution operation.

This type includes fields that provide information about the outcome of a DID resolution process, including the content type of the returned DID document and any errors that occurred during the resolution process.

This metadata typically changes between invocations of the resolve and resolveRepresentation functions, as it represents data about the resolution process itself.

Type declaration

  • [key: string]: any
  • Optional contentType?: string

    The Media Type of the returned didDocumentStream.

    This property is REQUIRED if resolution is successful and if the resolveRepresentation function was called. This property MUST NOT be present if the resolve function was called. The value of this property MUST be an ASCII string that is the Media Type of the conformant representations. The caller of the resolveRepresentation function MUST use this value when determining how to parse and process the didDocumentStream returned by this function into the data model.

  • Optional error?: string

    An error code indicating issues encountered during the DID Resolution or DID URL Dereferencing process.

    Defined error codes include:

    • internalError: An unexpected error occurred during DID Resolution or DID URL dereferencing process.
    • invalidDid: The provided DID is invalid.
    • methodNotSupported: The DID method specified is not supported.
    • notFound: The DID or DID URL does not exist.
    • representationNotSupported: The DID document representation is not supported.
    • Custom error codes can also be provided as strings.

    See

See

DID Core Specification, § DID Resolution Metadata

Settings

Member Visibility

Theme