mapIdentifierKeysToDoc() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Maps the keys of a locally managed IIdentifier to the corresponding entries from the DID document.
Signature:
export declare function mapIdentifierKeysToDoc(
identifier: IIdentifier,
section: DIDDocumentSection | undefined,
context: IAgentContext<IResolver>,
resolutionOptions?: DIDResolutionOptions,
): Promise<_ExtendedIKey[]>
Parameters
Parameter | Type | Description |
---|---|---|
identifier | IIdentifier | the identifier to be mapped |
section | DIDDocumentSection | undefined | the section of the DID document to be mapped (see verification relationships), but can also be verificationMethod to map all the keys. |
context | IAgentContext<IResolver> | the veramo agent context, which must contain a IResolver implementation that can resolve the DID document of the identifier. |
resolutionOptions | DIDResolutionOptions | (Optional) optional parameters to be passed to the DID resolver |
Returns:
Promise<_ExtendedIKey[]>
an array of mapped keys. The corresponding verification method is added to the meta.verificationMethod
property of the key.
This API may change without a BREAKING CHANGE notice.