fix(exp): document expirationTimestamp

energywebfoundation · Aug 10, 2022 · c7c5b17 · c7c5b17
1 parent ff6886c
commit c7c5b17
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/docs/api/interfaces/modules_claims.IssueClaimOptions.md b/docs/api/interfaces/modules_claims.IssueClaimOptions.md
@@ -40,7 +40,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

diff --git a/docs/api/interfaces/modules_claims.IssueClaimRequestOptions.md b/docs/api/interfaces/modules_claims.IssueClaimRequestOptions.md
@@ -28,7 +28,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

diff --git a/docs/api/interfaces/modules_claims.IssueVerifiablePresentationOptions.md b/docs/api/interfaces/modules_claims.IssueVerifiablePresentationOptions.md
@@ -25,7 +25,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

diff --git a/docs/api/interfaces/modules_claims.RegisterOnchainOptions.md b/docs/api/interfaces/modules_claims.RegisterOnchainOptions.md
@@ -45,7 +45,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

diff --git a/docs/api/interfaces/modules_did_registry.IssuePublicClaimOptions.md b/docs/api/interfaces/modules_did_registry.IssuePublicClaimOptions.md
@@ -16,7 +16,7 @@
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

diff --git a/src/modules/claims/claims.types.ts b/src/modules/claims/claims.types.ts
@@ -198,7 +198,7 @@ export interface IssueClaimRequestOptions {
    */
   credentialStatusOverride?: StatusList2021Entry;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 
@@ -224,7 +224,7 @@ export interface RegisterOnchainOptions {
   /** DID of the claim subject */
   subject?: string;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 
@@ -269,7 +269,7 @@ export interface IssueClaimOptions {
    */
   credentialStatusOverride?: StatusList2021Entry;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 
@@ -337,7 +337,7 @@ export interface IssueVerifiablePresentationOptions {
    */
   credentialStatus?: StatusList2021Entry;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 

diff --git a/src/modules/did-registry/did.types.ts b/src/modules/did-registry/did.types.ts
@@ -68,7 +68,7 @@ export interface IssuePublicClaimOptions {
   /* Public claim data object */
   publicClaim?: IPublicClaim;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }