flowscale 1.0.3 → 1.0.4
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 +19 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Flowscale Node.js SDK
|
|
2
|
+
|
|
3
|
+
A Node.js SDK for interacting with the Flowscale platform without directly managing API requests. This library simplifies invoking workflows, retrieving outputs, and checking run statuses.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install flowscale
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## Methods
|
|
12
|
+
|
|
13
|
+
- checkHealth(): Promise<HealthCheckResponse>
|
|
14
|
+
- getQueue(): Promise<QueueResponse>
|
|
15
|
+
- executeWorkflow(workflowId: string, data: WorkflowData, groupId?: string): Promise<ExecuteWorkflowResponse>
|
|
16
|
+
- getOutput(filename: string): Promise<GetOutputResponse | null>
|
|
17
|
+
- cancelRun(runId: string): Promise<CancelRunResponse>
|
|
18
|
+
- getRun(runId: string): Promise<RunDetailResponse>
|
|
19
|
+
- getRuns(groupId: string): Promise<RunListResponse>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "flowscale",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "An NPM library for communicating with the Flowscale APIs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"build": "tsc",
|
|
9
9
|
"test": "echo \"No tests yet\""
|
|
10
10
|
},
|
|
11
|
-
"author": "
|
|
11
|
+
"author": "flowscale",
|
|
12
12
|
"license": "MIT",
|
|
13
13
|
"dependencies": {
|
|
14
14
|
"axios": "^1.7.7",
|