From d101f7a3e8bc2fac0f79789eac9c4fd748d67485 Mon Sep 17 00:00:00 2001 From: Paul Butler Date: Wed, 9 Oct 2024 12:28:32 -0400 Subject: [PATCH] add docstring --- js-pkg/sdk/src/main.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/js-pkg/sdk/src/main.ts b/js-pkg/sdk/src/main.ts index 3095ed12..945001fb 100644 --- a/js-pkg/sdk/src/main.ts +++ b/js-pkg/sdk/src/main.ts @@ -70,6 +70,7 @@ export class DocumentManager { * client. * * @param docId The ID of the document to get a token for. + * @param authDocRequest An optional {@link AuthDocRequest} providing options for the token request. * @returns A {@link ClientToken} object containing the URL and token needed to connect to the document. */ public async getClientToken( @@ -94,6 +95,7 @@ export class DocumentManager { * that one is created. If no docId is provided, a new document is created with a random ID. * * @param docId The ID of the document to get or create. If not provided, a new document with a random ID will be created. + * @param authDocRequest An optional {@link AuthDocRequest} providing options for the token request. * @returns A {@link ClientToken} object containing the URL and token needed to connect to the document. */ public async getOrCreateDocAndToken( @@ -141,6 +143,7 @@ export class DocumentManager { * * @param connectionString A connection string (starting with `ys://` or `yss://`) referring to a y-sweet server. * @param docId The ID of the document to get or create. If not provided, a new document with a random ID will be created. + * @param authDocRequest An optional {@link AuthDocRequest} providing options for the token request. * @returns A {@link ClientToken} object containing the URL and token needed to connect to the document. */ export async function getOrCreateDocAndToken( @@ -157,6 +160,7 @@ export async function getOrCreateDocAndToken( * * @param connectionString A connection string (starting with `ys://` or `yss://`) referring to a y-sweet server. * @param docId The ID of the document to get a token for. + * @param authDocRequest An optional {@link AuthDocRequest} providing options for the token request. * @returns A {@link ClientToken} object containing the URL and token needed to connect to the document. */ export async function getClientToken(