Type alias DidDereferencingMetadata

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

Represents metadata related to the process of DID dereferencing.

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

Type declaration

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

    The Media Type of the returned contentStream SHOULD be expressed using this property if dereferencing is successful.

  • Optional error?: string

    The error code from the dereferencing process. This property is REQUIRED when there is an error in the dereferencing process. The value of this property MUST be a single keyword expressed as an ASCII string. The possible property values of this field SHOULD be registered in the DID Specification Registries. The DID Core specification defines the following common error values:

    • invalidDidUrl: The DID URL supplied to the DID URL dereferencing function does not conform to valid syntax.
    • notFound: The DID URL dereferencer was unable to find the contentStream resulting from this dereferencing request.

    See

    DID Core Specification, § DID URL Dereferencing Metadata

See

DID Core Specification, § DID URL Dereferencing Metadata

Settings

Member Visibility

Theme