Replace eslint jsdoc with tsdoc

.eslintignore

@@ -3,3 +3,4 @@ dist
 generated
 protos
 **/*.js
+**/*.test.ts

.eslintrc.js

@@ -1,12 +1,8 @@
 module.exports = {
   root: true,
   parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint", "jsdoc"],
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:jsdoc/recommended",
-  ],
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
   rules: {
     "no-constant-condition": ["error", { checkLoops: false }],
     // prettier decides
@@ -22,17 +18,6 @@ module.exports = {
     // better handled by ts itself
     "@typescript-eslint/no-unused-vars": ["off"],
 
-    "jsdoc/check-alignment": ["off"],
-    "jsdoc/check-examples": ["warn"],
-    "jsdoc/check-indentation": ["warn"],
-    "jsdoc/check-syntax": ["warn"],
-    "jsdoc/check-tag-names": ["warn", { definedTags: ["jest-environment"] }],
-    "jsdoc/newline-after-description": ["warn", "never"],
-    "jsdoc/no-types": ["error", { contexts: ["any"] }],
-    "jsdoc/require-description": ["warn"],
-    "jsdoc/require-description-complete-sentence": ["warn"],
-    "jsdoc/require-jsdoc": ["off"],
-    "jsdoc/require-param-type": ["off"],
-    "jsdoc/require-returns": ["off"],
+    "tsdoc/syntax": "warn",
   },
 };

package.json

@@ -89,7 +89,7 @@
     "docker-compose": "^0.24.7",
     "dotenv": "^10.0.0",
     "eslint": "^7.32.0",
-    "eslint-plugin-jsdoc": "^40.3.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "get-port": "^5.1.1",
     "grpc-tools": "^1.12.4",
     "grpc_tools_node_protoc_ts": "^5.3.3",

src/Client/index.ts

@@ -45,28 +45,28 @@ interface ClientOptions {
   /**
    * The amount of time (in milliseconds) to wait after which a keepalive ping is sent on the transport.
    * Use -1 to disable.
-   * @default 10_000
+   * @defaultValue 10_000
    */
   keepAliveInterval?: number;
   /**
    * The amount of time (in milliseconds) the sender of the keepalive ping waits for an acknowledgement.
    * If it does not receive an acknowledgment within this time, it will close the connection.
-   * @default 10_000
+   * @defaultValue 10_000
    */
   keepAliveTimeout?: number;
   /**
    * Whether or not to immediately throw an exception when an append fails.
-   * @default true
+   * @defaultValue true
    */
   throwOnAppendFailure?: boolean;
   /**
    * An optional length of time (in milliseconds) to use for gRPC deadlines.
-   * @default 10_000
+   * @defaultValue 10_000
    */
   defaultDeadline?: number;
   /**
    * The name of the connection to use in logs.
-   * @default uuid
+   * @defaultValue uuid
    */
   connectionName?: string;
 }
@@ -118,13 +118,11 @@ export interface ChannelCredentialOptions {
    */
   rootCertificate?: Buffer;
   /**
-   * This has been deprecated in favor of {@link userKeyFile}.
-   * @deprecated
+   * @deprecated Use the new {@link userKeyFile} instead.
    */
   privateKey?: Buffer;
   /**
-   * This has been deprecated in favor of {@link userCertFile}.
-   * @deprecated
+   * @deprecated Use the new {@link userCertFile} instead.
    */
   certChain?: Buffer;
   /**
@@ -165,10 +163,9 @@ export class Client {
   #http: HTTP;
   #connectionName: string;
 
-  // eslint-disable-next-line jsdoc/require-param
   /**
    * Returns a connection from a connection string.
-   * @param connectionString The connection string for your database.
+   * @param connectionString - The connection string for your database.
    */
   static connectionString(
     connectionString: TemplateStringsArray | string,

src/persistentSubscription/createPersistentSubscriptionToAll.ts

@@ -27,10 +27,10 @@ declare module "../Client" {
      * server remembers where the read offset is. This allows for many different modes of operations compared to a
      * regular subscription where the client holds the read offset. The group name must be unique.
      * Available from server version 21.10 onwards.
-     * @param groupName A group name.
-     * @param settings PersistentSubscription settings.
+     * @param groupName - A group name.
+     * @param settings - PersistentSubscription settings.
      * @see {@link persistentSubscriptionToStreamSettingsFromDefaults}
-     * @param options Command options.
+     * @param options - Command options.
      */
     createPersistentSubscriptionToAll(
       groupName: string,

src/persistentSubscription/createPersistentSubscriptionToStream.ts

@@ -15,11 +15,11 @@ declare module "../Client" {
      * Creates a persistent subscription on a stream. Persistent subscriptions are special kind of subscription where the
      * server remembers where the read offset is at. This allows for many different modes of operations compared to a
      * regular subscription where the client holds the read offset. The pair stream name and group must be unique.
-     * @param streamName A stream name.
-     * @param groupName A group name.
-     * @param settings PersistentSubscription settings.
+     * @param streamName - A stream name.
+     * @param groupName - A group name.
+     * @param settings - PersistentSubscription settings.
      * @see {@link persistentSubscriptionToStreamSettingsFromDefaults}
-     * @param options Command options.
+     * @param options - Command options.
      */
     createPersistentSubscriptionToStream(
       streamName: string,

src/persistentSubscription/deletePersistentSubscriptionToAll.ts

@@ -15,9 +15,9 @@ declare module "../Client" {
   interface Client {
     /**
      * Deletes a persistent subscription.
-     * @param streamName A stream name.
-     * @param groupName A group name.
-     * @param options Deletion options.
+     * @param streamName - A stream name.
+     * @param groupName - A group name.
+     * @param options - Deletion options.
      */
     deletePersistentSubscriptionToAll(
       groupName: string,

src/persistentSubscription/deletePersistentSubscriptionToStream.ts

@@ -12,9 +12,9 @@ declare module "../Client" {
   interface Client {
     /**
      * Deletes a persistent subscription.
-     * @param streamName A stream name.
-     * @param groupName A group name.
-     * @param options Deletion options.
+     * @param streamName - A stream name.
+     * @param groupName - A group name.
+     * @param options - Deletion options.
      */
     deletePersistentSubscriptionToStream(
       streamName: string,

src/persistentSubscription/getPersistentSubscriptionToAllInfo.ts

@@ -20,8 +20,8 @@ declare module "../Client" {
   interface Client {
     /**
      * Gets information and statistics on the specified persistent subscription to $all and its connections.
-     * @param groupName A group name.
-     * @param options Get persistent subscription to all options.
+     * @param groupName - A group name.
+     * @param options - Get persistent subscription to all options.
      */
     getPersistentSubscriptionToAllInfo(
       groupName: string,

src/persistentSubscription/getPersistentSubscriptionToStreamInfo.ts

@@ -26,9 +26,9 @@ declare module "../Client" {
   interface Client {
     /**
      * Gets information and statistics on the specified persistent subscription and its connections.
-     * @param streamName A stream name.
-     * @param groupName A group name.
-     * @param options Get persistent subscription info options.
+     * @param streamName - A stream name.
+     * @param groupName - A group name.
+     * @param options - Get persistent subscription info options.
      */
     getPersistentSubscriptionToStreamInfo(
       streamName: string,

src/persistentSubscription/listAllPersistentSubscriptions.ts

@@ -22,7 +22,7 @@ declare module "../Client" {
   interface Client {
     /**
      * Lists all persistent subscriptions.
-     * @param options List persistent subscriptions options.
+     * @param options - List persistent subscriptions options.
      */
     listAllPersistentSubscriptions(
       options?: ListPersistentSubscriptionsOptions

src/persistentSubscription/listPersistentSubscriptionsToAll.ts

@@ -20,7 +20,7 @@ declare module "../Client" {
   interface Client {
     /**
      * Lists persistent subscriptions to the $all stream.
-     * @param options List persistent subscriptions options.
+     * @param options - List persistent subscriptions options.
      */
     listPersistentSubscriptionsToAll(
       options?: ListPersistentSubscriptionsToAllOptions

src/persistentSubscription/listPersistentSubscriptionsToStream.ts

@@ -26,8 +26,8 @@ declare module "../Client" {
   interface Client {
     /**
      * Lists persistent subscriptions to a stream.
-     * @param streamName A stream name.
-     * @param options List persistent subscriptions options.
+     * @param streamName - A stream name.
+     * @param options - List persistent subscriptions options.
      */
     listPersistentSubscriptionsToStream(
       streamName: string,

src/persistentSubscription/replayParkedMessagesToAll.ts

@@ -12,7 +12,7 @@ import { Client } from "../Client";
 export interface ReplayParkedMessagesToAllOptions extends BaseOptions {
   /**
    * When to stop replaying parked messages. Leave undefined to have no limit.
-   * @default undefined
+   * @defaultValue undefined
    */
   stopAt?: number | bigint;
 }
@@ -21,8 +21,8 @@ declare module "../Client" {
   interface Client {
     /**
      * Replays the parked messages of a persistent subscription to $all.
-     * @param groupName A group name.
-     * @param options Replay options.
+     * @param groupName - A group name.
+     * @param options - Replay options.
      */
     replayParkedMessagesToAll(
       groupName: string,

src/persistentSubscription/replayParkedMessagesToStream.ts

@@ -17,7 +17,7 @@ import { Client } from "../Client";
 export interface ReplayParkedMessagesToStreamOptions extends BaseOptions {
   /**
    * When to stop replaying parked messages. Leave undefined to have no limit.
-   * @default undefined
+   * @defaultValue undefined
    */
   stopAt?: number | bigint;
 }
@@ -26,9 +26,9 @@ declare module "../Client" {
   interface Client {
     /**
      * Replays the parked messages of a persistent subscription.
-     * @param streamName A stream name.
-     * @param groupName A group name.
-     * @param options Replay options.
+     * @param streamName - A stream name.
+     * @param groupName - A group name.
+     * @param options - Replay options.
      */
     replayParkedMessagesToStream(
       streamName: string,

src/persistentSubscription/restartPersistentSubscriptionSubsystem.ts

@@ -15,7 +15,7 @@ declare module "../Client" {
   interface Client {
     /**
      * Restarts the persistent subscription subsystem.
-     * @param options Restart subsystem options.
+     * @param options - Restart subsystem options.
      */
     restartPersistentSubscriptionSubsystem(
       options?: RestartPersistentSubscriptionSubsystemOptions

src/persistentSubscription/subscribeToPersistentSubscriptionToAll.ts

@@ -20,7 +20,7 @@ export interface SubscribeToPersistentSubscriptionToAllOptions
   extends BaseOptions {
   /**
    * The buffer size to use for the persistent subscription.
-   * @default 10
+   * @defaultValue 10
    */
   bufferSize?: number;
 }
@@ -29,9 +29,9 @@ declare module "../Client" {
   interface Client {
     /**
      * Connects to a persistent subscription.
-     * @param stream A stream name.
-     * @param group A group name.
-     * @param options Connection options.
+     * @param stream - A stream name.
+     * @param group - A group name.
+     * @param options - Connection options.
      */
     subscribeToPersistentSubscriptionToAll(
       groupName: string,

src/persistentSubscription/subscribeToPersistentSubscriptionToStream.ts

@@ -21,7 +21,7 @@ export interface SubscribeToPersistentSubscriptionToStreamOptions
   extends BaseOptions {
   /**
    * The buffer size to use for the persistent subscription.
-   * @default 10
+   * @defaultValue 10
    */
   bufferSize?: number;
 }
@@ -30,9 +30,9 @@ declare module "../Client" {
   interface Client {
     /**
      * Connects to a persistent subscription.
-     * @param stream A stream name.
-     * @param group A group name.
-     * @param options Connection options.
+     * @param stream - A stream name.
+     * @param group - A group name.
+     * @param options - Connection options.
      */
     subscribeToPersistentSubscriptionToStream<E extends EventType = EventType>(
       streamName: string,

src/persistentSubscription/updatePersistentSubscriptionToAll.ts

@@ -19,10 +19,10 @@ declare module "../Client" {
   interface Client {
     /**
      * Updates a persistent subscription to all configuration.
-     * @param groupName A group name.
-     * @param settings PersistentSubscriptionToAll settings.
+     * @param groupName - A group name.
+     * @param settings - PersistentSubscriptionToAll settings.
      * @see {@link persistentSubscriptionToAllSettingsFromDefaults}
-     * @param options Command options.
+     * @param options - Command options.
      */
     updatePersistentSubscriptionToAll(
       groupName: string,

src/persistentSubscription/updatePersistentSubscriptionToStream.ts

@@ -13,11 +13,11 @@ declare module "../Client" {
   interface Client {
     /**
      * Updates a persistent subscription configuration.
-     * @param streamName A stream name.
-     * @param groupName A group name.
-     * @param settings PersistentSubscription settings.
+     * @param streamName - A stream name.
+     * @param groupName - A group name.
+     * @param settings - PersistentSubscription settings.
      * @see {@link persistentSubscriptionToStreamSettingsFromDefaults}
-     * @param options Command options.
+     * @param options - Command options.
      */
     updatePersistentSubscriptionToStream(
       streamName: string,