- Added comments.

magieno · Dec 2, 2023 · 3e6a927 · 3e6a927
1 parent 8a00ff7
commit 3e6a927
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/stripe/src/clients/stripe.client.ts b/packages/stripe/src/clients/stripe.client.ts
@@ -37,6 +37,11 @@ export class StripeClient implements StripeClientInterface{
     ) {
     }
 
+    /**
+     * This method filters the Credentials Provider base on the provided this.credentialProviderUniqueName attribute. It
+     * checks that there's actually a credential provider that matches the provided unique name.
+     * @private
+     */
     private getCredentialProvider(): CredentialsProviderInterface {
         if(!this.credentialProviderUniqueName) {
             this.logHandler.error(`The configuration '${StripeModuleKeyname}.credential_provider.name' contains an invalid unique name: '${this.credentialProviderUniqueName}'}`)

diff --git a/packages/stripe/src/interfaces/credentials-provider.interface.ts b/packages/stripe/src/interfaces/credentials-provider.interface.ts
@@ -1,5 +1,11 @@
 export interface CredentialsProviderInterface {
+    /**
+     * This method returns the Stripe API Key.
+     */
     getStripeApiKey(): string;
 
+    /**
+     * This method returns a unique string uniquely identifying the Credential Provider.
+     */
     getUniqueName(): string
 }