@ew-did-registry/did
Version:
The interface of a Decentralised Identity
51 lines (50 loc) • 1.39 kB
TypeScript
import { IDID } from './interface';
import { Methods, Chain } from './models';
declare class DID implements IDID {
/**
* Mappings from methods to DIDs
*/
private _dids;
/**
* Gets a DID for a particular method
*
* @example
* ```typescript
* import { DID, Network } from '@ew-did-registry/did';
*
* const did = new DID();
* did.set('bitcoin', 'method_specific_id');
* console.log(did.get('bitcoin')); // 'did:bitcoin:method_specific_id'
*
* const did = new DID();
* did.set(Methods.Erc1056, 'method_specific_id');
* console.log(did.get(Methods.Erc1056)); // 'did:eth:method_specific_id'
* ```
*
* @param { Methods } method
*
* @returns { string|undefined }
*/
get(method: Methods): string | undefined;
/**
* Sets a DID for a particular method (inferred from DID provided)
*
* @example
* ```typescript
* import { DID } from '@ew-did-registry/did';
*
* const did = new DID();
* did.set('did:eth:method_specific_id');
* console.log(did.get('eth')); // 'did:eth:method_specific_id'
* ```
*
* @param {string} did
*
* @returns {void}
*/
set(did: string): IDID;
private _setDid;
}
export { IDID, DID, Methods, Chain };
export * from './utils/validation';
export * from './utils/parser';