Added documentation example

d-velop · Oct 13, 2023 · 97b4e6c · 97b4e6c
1 parent 6485daa
commit 97b4e6c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/dms/package.json b/packages/dms/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@dvelop-sdk/dms",
   "description": "This package contains functionality for the DMS-App in the d.velop cloud.",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

diff --git a/packages/dms/src/dms-objects/get-dms-object-notes/get-dms-object-notes.ts b/packages/dms/src/dms-objects/get-dms-object-notes/get-dms-object-notes.ts
@@ -80,13 +80,20 @@ export function _getDmsObjectNotesFactory<T>(
  * ```typescript
  * import { getDmsObjectNotes } from "@dvelop-sdk/dms";
  *
- * await getDmsObjectNotes({
+ * const notes: DmsObjectNote[] = getDmsObjectNotes({
  *   systemBaseUri: "https://steamwheedle-cartel.d-velop.cloud",
  *   authSessionId: "dQw4w9WgXcQ"
  * }, {
  *   repositoryId: "qnydFmqHuVo",
  *   dmsObjectId: "GDYQ3PJKrT8"
  * });
+ *
+ * notes.forEach(n => {
+ *   console.log(`${n.creator.displayName}: "${n.text}"`);
+ * });
+ *
+ * // Jastor Gallywix: "I need this taken care of ASAP!"
+ * // Bing Zapcrackle: "I'm on it my prince."
  * ```
  *
  * @category DmsObject