@pgflow/dsl 0.2.2 → 0.2.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 +3 -3
- package/dist/CHANGELOG.md +4 -0
- package/dist/README.md +3 -3
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @pgflow/dsl
|
|
2
2
|
|
|
3
|
-
The TypeScript Domain Specific Language (DSL) for defining type-safe workflow definitions in
|
|
3
|
+
The TypeScript Domain Specific Language (DSL) for defining type-safe workflow definitions in pgflow.
|
|
4
4
|
|
|
5
5
|
> [!NOTE]
|
|
6
6
|
> This project and all its components are licensed under [Apache 2.0](./LICENSE) license.
|
|
@@ -62,7 +62,7 @@ export const AnalyzeWebsite = new Flow<Input>({
|
|
|
62
62
|
|
|
63
63
|
### Understanding Data Flow
|
|
64
64
|
|
|
65
|
-
In
|
|
65
|
+
In pgflow, each step receives an `input` object that contains:
|
|
66
66
|
|
|
67
67
|
1. **`input.run`** - The original flow input (available to all steps)
|
|
68
68
|
2. **`input.{stepName}`** - Outputs from dependency steps
|
|
@@ -96,7 +96,7 @@ const sqlStatements = compileFlow(MyFlow);
|
|
|
96
96
|
console.log(sqlStatements.join('\n'));
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Alternatively, use the
|
|
99
|
+
Alternatively, use the pgflow CLI to compile flows directly to migration files:
|
|
100
100
|
|
|
101
101
|
```bash
|
|
102
102
|
npx pgflow compile path/to/flow.ts
|
package/dist/CHANGELOG.md
CHANGED
package/dist/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @pgflow/dsl
|
|
2
2
|
|
|
3
|
-
The TypeScript Domain Specific Language (DSL) for defining type-safe workflow definitions in
|
|
3
|
+
The TypeScript Domain Specific Language (DSL) for defining type-safe workflow definitions in pgflow.
|
|
4
4
|
|
|
5
5
|
> [!NOTE]
|
|
6
6
|
> This project and all its components are licensed under [Apache 2.0](./LICENSE) license.
|
|
@@ -62,7 +62,7 @@ export const AnalyzeWebsite = new Flow<Input>({
|
|
|
62
62
|
|
|
63
63
|
### Understanding Data Flow
|
|
64
64
|
|
|
65
|
-
In
|
|
65
|
+
In pgflow, each step receives an `input` object that contains:
|
|
66
66
|
|
|
67
67
|
1. **`input.run`** - The original flow input (available to all steps)
|
|
68
68
|
2. **`input.{stepName}`** - Outputs from dependency steps
|
|
@@ -96,7 +96,7 @@ const sqlStatements = compileFlow(MyFlow);
|
|
|
96
96
|
console.log(sqlStatements.join('\n'));
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Alternatively, use the
|
|
99
|
+
Alternatively, use the pgflow CLI to compile flows directly to migration files:
|
|
100
100
|
|
|
101
101
|
```bash
|
|
102
102
|
npx pgflow compile path/to/flow.ts
|
package/dist/package.json
CHANGED