Skip to content

Commit e602916

Browse files
committed
better jsdoc
1 parent 411ba18 commit e602916

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

packages/js-server-sdk/src/client.ts

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ export class FishjamClient {
3232
/**
3333
* Create new instance of Fishjam Client.
3434
*
35-
* The constructor does NOT verify the provided credentials against the
36-
* Fishjam backend. Use {@link FishjamClient.create} or
37-
* {@link FishjamClient.checkCredentials} to verify them at construction time.
35+
* Throws {@link MissingFishjamIdException} or
36+
* {@link MissingManagementTokenException} if either field is missing.
37+
* Does not verify credentials against the backend — use
38+
* {@link FishjamClient.create} or call
39+
* {@link FishjamClient.checkCredentials} afterwards for that.
3840
*
3941
* Example usage:
4042
* ```
@@ -68,11 +70,12 @@ export class FishjamClient {
6870
}
6971

7072
/**
71-
* Async factory. Constructs a client and verifies that the provided
72-
* `fishjamId` and `managementToken` are accepted by the Fishjam backend.
73+
* Async factory: constructs a client and verifies credentials against
74+
* the backend.
7375
*
74-
* Throws {@link InvalidFishjamConfigException} for malformed config,
75-
* {@link UnauthorizedException} for bad credentials, or
76+
* Throws {@link MissingFishjamIdException} /
77+
* {@link MissingManagementTokenException} for missing fields,
78+
* {@link UnauthorizedException} for bad credentials,
7679
* {@link FishjamNotFoundException} for an unknown `fishjamId`.
7780
*
7881
* Example:

0 commit comments

Comments
 (0)