@caido/sdk-workflow 0.41.1-beta.2 → 0.41.1-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +2 -2
  2. package/src/typing.d.ts +10 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caido/sdk-workflow",
3
- "version": "0.41.1-beta.2",
3
+ "version": "0.41.1-beta.3",
4
4
  "description": "Typing for the Caido Workflow SDK",
5
5
  "author": "Caido Labs Inc. <dev@caido.io>",
6
6
  "license": "MIT",
@@ -9,7 +9,7 @@
9
9
  "src/*"
10
10
  ],
11
11
  "dependencies": {
12
- "@caido/quickjs-types": "0.8.3"
12
+ "@caido/quickjs-types": "0.8.4"
13
13
  },
14
14
  "scripts": {
15
15
  "documentation": "typedoc"
package/src/typing.d.ts CHANGED
@@ -49,7 +49,7 @@ declare module "caido:workflow" {
49
49
  */
50
50
  export type SDK = {
51
51
  /**
52
- * The console.
52
+ * The console for logging.
53
53
  *
54
54
  * This is currently the same as the global `console`.
55
55
  */
@@ -70,6 +70,15 @@ declare module "caido:workflow" {
70
70
  * Converts bytes to a string.
71
71
  *
72
72
  * Unprintable characters will be replaced with `�`.
73
+ *
74
+ * @example
75
+ * ```js
76
+ * export function run(input, sdk) {
77
+ * let parsed = sdk.asString(input);
78
+ * sdk.console.log(parsed);
79
+ * return parsed;
80
+ * }
81
+ * ```
73
82
  */
74
83
  asString(array: Bytes): string;
75
84
  };