document escapeJSON datastore helper function

slackapi · Nov 4, 2024 · 4ec7f60 · 4ec7f60
1 parent bcbc1fd
commit 4ec7f60
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/cli-test/src/cli/commands/datastore.ts b/packages/cli-test/src/cli/commands/datastore.ts
@@ -14,6 +14,9 @@ export interface DatastoreCommandArguments {
   queryExpressionValues: object;
 }
 
+/**
+ * Used to escape double quotes in JSON strings; this is needed when JSON is passed as a command line argument, which for the datastore commands, it is.
+ */
 function escapeJSON(obj: Record<string, unknown>): string {
   return `"${JSON.stringify(obj).replace(/"/g, '\\"')}"`;
 }