Skip to content

Commit

Permalink
Removed versions from params
Browse files Browse the repository at this point in the history
  • Loading branch information
djfarrelly committed Sep 25, 2024
1 parent 1d8cb4c commit 3c1eee4
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions pages/docs/reference/workflow-kit/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The actions need to be separated into 2 distinct objects to avoid leaking the ac
</Callout>

<Properties>
<Property name="handler" type="function" version="v0.0.1+">
<Property name="handler" type="function">
The handler is your code that runs whenever the action occurs. Every function handler receives a single object argument which can be deconstructed. The key arguments are `event` and `step`.
</Property>
</Properties>
Expand All @@ -116,16 +116,16 @@ The details of the `handler()` **unique argument's properties** can be found bel
### `handler()` function argument properties

<Properties>
<Property name="event" type="TriggerEvent" version="v0.0.1+">
<Property name="event" type="TriggerEvent">
See the Inngest Function handler [`event` argument property definition](/docs/reference/functions/create#event).
</Property>
<Property name="step" type="Step" version="v0.0.1+">
<Property name="step" type="Step">
See the Inngest Function handler [`step` argument property definition](/docs/reference/functions/create#step).
</Property>
<Property name="workflow" type="Workflow" version="v0.0.1+">
<Property name="workflow" type="Workflow">
See the [Workflow instance format](/docs/reference/workflow-kit/workflow-instance).
</Property>
<Property name="workflowAction" type="WorkflowAction" version="v0.0.1+">
<Property name="workflowAction" type="WorkflowAction">
WorkflowAction is the action being executed, with fully interpolated inputs.

Key properties are:
Expand All @@ -135,7 +135,7 @@ The details of the `handler()` **unique argument's properties** can be found bel
- `description?: string`: The description, as provided in the [`PublicEngineAction`](#passing-actions-to-the-react-components-public-engine-action).
- `inputs?: string`: The record key is the key of the EngineAction inoput name, and the value is the variable's value.
</Property>
<Property name="state" type="object" version="v0.0.1+">
<Property name="state" type="object">
State represnets the current state of the workflow, with previous action's outputs recorded as key-value pairs.
</Property>
</Properties>
Expand Down
12 changes: 6 additions & 6 deletions pages/docs/reference/workflow-kit/components-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,22 +52,22 @@ Make sure to updated `workflow={}` based on the updates received via `onChange={


<Properties>
<Property name="workflow" type="Workflow" version="v0.0.1+" required>
<Property name="workflow" type="Workflow" required>
A [Workflow instance object](/docs/reference/workflow-kit/workflow-instance).
</Property>
<Property name="trigger" type="object" version="v0.0.1+" required>
<Property name="trigger" type="object" required>
An object with a `name: string` property [representing an event name](/docs/reference/functions/create#trigger).
</Property>
<Property name="availableActions" type="PublicEngineAction[]" version="v0.0.1+">
<Property name="availableActions" type="PublicEngineAction[]">
See [the `PublicEngineActionEngineAction[]` reference](/docs/reference/workflow-kit/actions#passing-actions-to-the-react-components-public-engine-action).
</Property>
<Property name="onChange" type="function" version="v0.0.1+" required>
<Property name="onChange" type="function" required>
A callback function, called after each `workflow` changes.
</Property>
<Property name="onChange" type="function" version="v0.0.1+" required>
<Property name="onChange" type="function" required>
A callback function, called after each `workflow` changes.
</Property>
<Property name="{children}" type="React.ReactNode" version="v0.0.1+" required>
<Property name="{children}" type="React.ReactNode" required>
The `<Provider>` component should always get the following tree as children:
</Property>
</Properties>
Expand Down
6 changes: 3 additions & 3 deletions pages/docs/reference/workflow-kit/engine.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ export default inngest.createFunction(


<Properties>
<Property name="actions" type="EngineAction[]" version="v0.0.1+">
<Property name="actions" type="EngineAction[]">
See [the `EngineAction[]` reference](/docs/reference/workflow-kit/actions#passing-actions-to-the-workflow-engine-engine-action).
</Property>
<Property name="loader" type="function" version="v0.0.1+">
<Property name="loader" type="function">
An async function receiving the [`event`](/docs/reference/functions/create#event) as unique argument and returning a valid [`Workflow` instance](/docs/reference/workflow-kit/workflow-instance) object.
</Property>
<Property name="disableBuiltinActions" type="boolean" version="v0.0.1+">
<Property name="disableBuiltinActions" type="boolean">
For selectively adding built-in actions, set this to true and expose the actions you want via the [`<Provider>`](/docs/reference/workflow-kit/components-api) `availableActions` prop.
</Property>
</Properties>

0 comments on commit 3c1eee4

Please sign in to comment.