abysshub 0.0.1-dev.10 → 0.0.1-dev.12
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/README.md +4 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ The official JavaScript library for the [Abyss](https://abysshub.com) API.
|
|
|
5
5
|
Pre-release: the Abyss API opens soon.
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
|
-
import
|
|
8
|
+
import Abyss, { AbyssError } from "abysshub";
|
|
9
9
|
|
|
10
10
|
const abyss = new Abyss(); // reads ABYSS_API_KEY
|
|
11
11
|
|
|
@@ -18,6 +18,8 @@ try {
|
|
|
18
18
|
}
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
+
`Abyss` is the package's default export, the form each Widget's page shows. The named form, `import { Abyss } from "abysshub"`, works too and is the same class.
|
|
22
|
+
|
|
21
23
|
`run()` presses the Widget and waits for the run to end, however long it takes, then returns the succeeded run. A refusal or a failed run raises `AbyssError`.
|
|
22
24
|
|
|
23
25
|
It runs on Node 20+, Bun and Deno, with no dependencies. An API key is a server-side secret, so in a browser `new Abyss()` throws.
|
|
@@ -80,7 +82,7 @@ while (page.has_more) page = await abyss.runs.list({ limit: 100, startingAfter:
|
|
|
80
82
|
## Files
|
|
81
83
|
|
|
82
84
|
```js
|
|
83
|
-
import
|
|
85
|
+
import Abyss, { file } from "abysshub";
|
|
84
86
|
|
|
85
87
|
const run = await abyss.run("widget_1660", {
|
|
86
88
|
report: file("report.pdf"),
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { Abyss, type AbyssOptions, type CallOptions, type GetRunOptions, type ListRunsOptions, type RunOptions, type Runs, type UploadRequest, type Uploads, type Widgets, } from "./client.js";
|
|
1
|
+
export { Abyss, Abyss as default, type AbyssOptions, type CallOptions, type GetRunOptions, type ListRunsOptions, type RunOptions, type Runs, type UploadRequest, type Uploads, type Widgets, } from "./client.js";
|
|
2
2
|
export { AbyssError, type AbyssErrorFields } from "./error.js";
|
|
3
3
|
export { file, type FileData, type FileOptions, type InputFile } from "./files.js";
|
|
4
4
|
export type { Run, RunFile } from "./run.js";
|
package/dist/index.js
CHANGED
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, written from package.json by scripts/version.js at build. */
|
|
2
|
-
export declare const VERSION = "0.0.1-dev.
|
|
2
|
+
export declare const VERSION = "0.0.1-dev.12";
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/** This package's version, written from package.json by scripts/version.js at build. */
|
|
2
|
-
export const VERSION = "0.0.1-dev.
|
|
2
|
+
export const VERSION = "0.0.1-dev.12";
|
package/package.json
CHANGED