From 54baa6ef01c4ce8f8e02a7d67fa0c106971d1c14 Mon Sep 17 00:00:00 2001 From: Erdi Maden Date: Mon, 13 May 2024 13:40:10 -0500 Subject: [PATCH] fixing doc syntax --- src/coinbase/authenticator.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/coinbase/authenticator.ts b/src/coinbase/authenticator.ts index 9d00117e..e64a79b1 100644 --- a/src/coinbase/authenticator.ts +++ b/src/coinbase/authenticator.ts @@ -10,7 +10,7 @@ export class CoinbaseAuthenticator { private apiKey: string; private privateKey: string; - /* + /** * Initializes the Authenticator. * @constructor * @param {string} apiKey - The API key name. @@ -21,7 +21,7 @@ export class CoinbaseAuthenticator { this.privateKey = privateKey; } - /* + /** * Middleware to intercept requests and add JWT to the Authorization header for AxiosInterceptor * @param {MiddlewareRequestType} config - The request configuration. * @returns {MiddlewareRequestType} The request configuration with the Authorization header added. @@ -38,7 +38,7 @@ export class CoinbaseAuthenticator { return config; } - /* + /** * Builds the JWT for the given API endpoint URI. The JWT is signed with the API key's private key. * @param {string} url - The URI of the API endpoint. * @param {string} method - The HTTP method of the request. @@ -87,7 +87,7 @@ export class CoinbaseAuthenticator { } } - /* + /** * Extracts the PEM key from the given private key string. * @param {string} privateKeyString - The private key string. * @returns {string} The PEM key. @@ -104,7 +104,7 @@ export class CoinbaseAuthenticator { throw InvalidAPIKeyFormat; } - /* + /** * Generates a random nonce for the JWT. * @returns {string} */