Update docstring for method Client.register (#32)

antonlydell · web-flow · commit 4775830858cf · 2024-04-17T09:40:56.000-05:00
Added missing documentation for the credentialNickname parameter of the Client.register method.
diff --git a/src/passwordless.ts b/src/passwordless.ts
@@ -31,6 +31,7 @@ export class Client {
      * Register a new credential to a user
      *
      * @param {string} token Token generated by your backend and the Passwordless API
+     * @param {string} credentialNickname A nickname for the passkey credential being created
      */
     public async register(token: string, credentialNickname: string): PromiseResult<TokenResponse> {
         try {            

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ export class Client {`
`31`	`31`	`* Register a new credential to a user`
`32`	`32`	`*`
`33`	`33`	`* @param {string} token Token generated by your backend and the Passwordless API`
	`34`	`+ * @param {string} credentialNickname A nickname for the passkey credential being created`
`34`	`35`	`*/`
`35`	`36`	`public async register(token: string, credentialNickname: string): PromiseResult<TokenResponse> {`
`36`	`37`	`try {`