From 33faaa475111404501d897c06c8561b51b70eb51 Mon Sep 17 00:00:00 2001 From: Passerino Date: Tue, 1 Mar 2022 10:11:46 +0100 Subject: [PATCH] feat(did): renamed readServices to getServices for consistency --- docs/api/classes/DidRegistry.md | 42 +++++++++---------- .../didRegistry/didRegistry.service.ts | 2 +- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/api/classes/DidRegistry.md b/docs/api/classes/DidRegistry.md index 3f6e8a20..156bc62a 100644 --- a/docs/api/classes/DidRegistry.md +++ b/docs/api/classes/DidRegistry.md @@ -19,9 +19,9 @@ - [getDidDelegates](DidRegistry.md#getdiddelegates) - [getDidDocument](DidRegistry.md#getdiddocument) - [getDidPublicKeys](DidRegistry.md#getdidpublickeys) +- [getServices](DidRegistry.md#getservices) - [init](DidRegistry.md#init) - [issuePublicClaim](DidRegistry.md#issuepublicclaim) -- [readServices](DidRegistry.md#readservices) - [revokeDidDocument](DidRegistry.md#revokediddocument) - [updateDocument](DidRegistry.md#updatedocument) - [updateSignedDidDelegate](DidRegistry.md#updatesigneddiddelegate) @@ -175,6 +175,26 @@ list of public keys ___ +### getServices + +▸ **getServices**(`__namedParameters?`): `Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> + +**`description`** gets list of services endpoints from User's DID document + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `undefined` \| { `did?`: `string` } | + +#### Returns + +`Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> + +list of claims + +___ + ### init ▸ **init**(): `Promise`<`void`\> @@ -207,26 +227,6 @@ return issued token ___ -### readServices - -▸ **readServices**(`__namedParameters?`): `Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> - -**`description`** gets list of services endpoints from User's DID document - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `__namedParameters` | `undefined` \| { `did?`: `string` } | - -#### Returns - -`Promise`<`IServiceEndpoint` & [`ClaimData`](../interfaces/ClaimData.md)[]\> - -list of claims - -___ - ### revokeDidDocument ▸ **revokeDidDocument**(): `Promise`<`boolean`\> diff --git a/src/modules/didRegistry/didRegistry.service.ts b/src/modules/didRegistry/didRegistry.service.ts index 1d8c3d33..84c45827 100644 --- a/src/modules/didRegistry/didRegistry.service.ts +++ b/src/modules/didRegistry/didRegistry.service.ts @@ -155,7 +155,7 @@ export class DidRegistry { * @description gets list of services endpoints from User's DID document * @returns list of claims */ - async readServices({ + async getServices({ did = this._signerService.did, }: { did?: string } | undefined = {}) { const { service } = (await this.getDidDocument({ did })) || {};