fix: inline documentation for identities/Provider

MatrixAI · May 13, 2024 · f90af5d · f90af5d
1 parent d8f40a9
commit f90af5d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/src/identities/Provider.ts b/src/identities/Provider.ts
@@ -189,7 +189,7 @@ abstract class Provider {
   ): Promise<IdentitySignedClaim | undefined>;
 
   /**
-   * Stream pages of identity claimIds from an identity
+   * Stream a page of identity claimIds from an identity
    */
   public abstract getClaimIdsPage(
     authIdentityId: IdentityId,
@@ -226,7 +226,7 @@ abstract class Provider {
   }
 
   /**
-   * Stream identity claims from an identity
+   * Stream a page of identity claims from an identity
    */
   public async *getClaimsPage(
     authIdentityId: IdentityId,
@@ -254,7 +254,7 @@ abstract class Provider {
   }
 
   /**
-   * Stream pages of identity claims from an identity
+   * Stream identity claims from an identity
    */
   public async *getClaims(
     authIdentityId: IdentityId,

diff --git a/src/identities/providers/github/GitHubProvider.ts b/src/identities/providers/github/GitHubProvider.ts
@@ -520,7 +520,8 @@ class GitHubProvider extends Provider {
   }
 
   /**
-   * Gets all ProviderIdentityClaimIds from a given identity.
+   * Gets a page of ProviderIdentityClaimIds from a given identity
+   * sorted by latest.
    */
   public async *getClaimIdsPage(
     _authIdentityId: IdentityId,
@@ -562,7 +563,8 @@ class GitHubProvider extends Provider {
   }
 
   /**
-   * Gets all IdentitySignedClaims from a given identity.
+   * Gets all IdentitySignedClaims from a given identity
+   * sorted by latest.
    */
   public async *getClaimsPage(
     _authIdentityId: IdentityId,

diff --git a/src/identities/types.ts b/src/identities/types.ts
@@ -55,6 +55,12 @@ type ProviderAuthenticateRequest = {
   data: POJO;
 };
 
+/**
+ * Generic opaque string used to represent a pagination token
+ * when making requests using an identity Provider.
+ * Do not expect this string to have any particular meaning
+ * outside of the Provider subclass it is used for.
+ */
 type ProviderPaginationToken = Opaque<'ProviderPaginationToken', string>;
 
 export type {