chore: add deprecated jsdoc for notify (#72)

* add deprecated jsdoc * format * bump version number
knocklabs · May 15, 2024 · 2f87180 · 2f87180
1 parent 617333d
commit 2f87180
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.6.11",
+  "version": "0.6.12",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",
@@ -45,4 +45,4 @@
   "engines": {
     "node": ">=17.5.0"
   }
-}
+}
diff --git a/src/knock.ts b/src/knock.ts
@@ -69,7 +69,11 @@ class Knock {
     });
   }
 
-  // Delegate the notify function to the workflows trigger
+  /**
+   * Delegate the notify function to the workflows trigger
+   *
+   * @deprecated use workflows.trigger instead.
+   */
   async notify(
     workflowKey: string,
     properties: TriggerWorkflowProperties,