@harborclient/sdk 1.0.53 → 1.0.54
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.
- package/dist/snippets.d.ts +17 -1
- package/package.json +1 -1
package/dist/snippets.d.ts
CHANGED
|
@@ -1,10 +1,26 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Ambient globals for HarborClient request/post-request
|
|
2
|
+
* Ambient globals for HarborClient request/post-request scripts and snippet `.js` files.
|
|
3
|
+
*
|
|
4
|
+
* Enable in your editor with:
|
|
5
|
+
*
|
|
6
|
+
* ```ts
|
|
7
|
+
* /// <reference types="@harborclient/sdk/snippets" />
|
|
8
|
+
* ```
|
|
3
9
|
*
|
|
4
10
|
* Keep in sync with the runtime hc sandbox in harborclient
|
|
5
11
|
* `src/main/scripting/scriptApi.ts` and editor completions in
|
|
6
12
|
* `src/renderer/src/scripting/hcCompletions.ts`.
|
|
7
13
|
*
|
|
14
|
+
* **Import and export** — snippets whose **Name** ends in `.js` (for example
|
|
15
|
+
* `pass-testing.js` or `utils/helpers.js`) may be imported from scripts with
|
|
16
|
+
* relative ESM paths: `import { fn } from './pass-testing.js'`. Use standard
|
|
17
|
+
* `export function`, `export const`, and `export default` in snippet source.
|
|
18
|
+
* Cross-snippet imports are resolved at send time in HarborClient; the SDK does
|
|
19
|
+
* not type-check import paths between snippet files.
|
|
20
|
+
*
|
|
21
|
+
* **Not supported:** npm package imports, `require`, and Node.js built-ins.
|
|
22
|
+
* See [Request scripts — Snippets](https://harborclient.com/scripting#snippets).
|
|
23
|
+
*
|
|
8
24
|
* `hc.expect` is Chai BDD expect — see https://www.chaijs.com/api/bdd/
|
|
9
25
|
* `hc.response.to` provides Postman-style response matchers.
|
|
10
26
|
*/
|