Document raw to model functions

TBD54566975 · Feb 6, 2024 · 483dc1d · 483dc1d
1 parent 16e8880
commit 483dc1d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/packages/protocol/src/parser.ts b/packages/protocol/src/parser.ts
@@ -107,6 +107,12 @@ export class Parser {
     return resource
   }
 
+  /**
+   * Util for JSON.parse-ing a stringified Tbdex Message
+   * @param rawMessage - Either a stringified Tbdex Message or an object Tbdex Message
+   * @returns A Tbdex Message as an object
+   * @throws If the stringified message could not be JSON.parse'd
+   */
   static rawToMessageModel(rawMessage: MessageModel | string): MessageModel {
     try {
       return typeof rawMessage === 'string' ? JSON.parse(rawMessage): rawMessage
@@ -116,6 +122,12 @@ export class Parser {
     }
   }
 
+  /**
+   * Util for JSON.parse-ing a stringified Tbdex resource
+   * @param rawMessage - Either a stringified Tbdex resource or an object Tbdex resource
+   * @returns A Tbdex message as an object
+   * @throws If the stringified resource could not be JSON.parse'd
+   */
   static rawToResourceModel(rawMessage: ResourceModel | string): ResourceModel {
     try {
       return typeof rawMessage === 'string' ? JSON.parse(rawMessage): rawMessage