docs(claims): getClaimId

energywebfoundation · Aug 5, 2022 · affaef7 · affaef7
1 parent a79c496
commit affaef7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/api/classes/modules_claims.ClaimsService.md b/docs/api/classes/modules_claims.ClaimsService.md
@@ -292,6 +292,8 @@ ___
 
 ▸ **getClaimId**(`__namedParameters`): `Promise`<`string`\>
 
+Generates claim id or returns id of existing claim with same data
+
 #### Parameters
 
 | Name | Type |
@@ -303,6 +305,8 @@ ___
 
 `Promise`<`string`\>
 
+claim identifier
+
 ___
 
 ### getClaimsByIssuer

diff --git a/src/modules/claims/claims.service.ts b/src/modules/claims/claims.service.ts
@@ -700,7 +700,11 @@ export class ClaimsService {
     return message.issuedToken;
   }
 
-  // TODO: create docs annotations
+  /**
+   * Generates claim id or returns id of existing claim with same data
+   * @param {ClaimData} param.claimData - claim data 
+   * @returns claim identifier
+   */
   async getClaimId({ claimData }: { claimData: ClaimData }) {
     const services = await this._didRegistry.getServices();
     const service = services.find(