tabshift/payloadcms
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: payload proper nouns (#11792)

Browse Source 
Uses proper nouns in the docs where necessary for "Payload" and "Local
API".
This commit is contained in:
Jacob Fletcher
2025-03-21 09:04:11 -04:00
committed by GitHub
parent 4081953c18
commit 5f7202bbb8
17 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/jobs-queue/workflows.mdx
View File

@@ -27,7 +27,7 @@ To define a JS-based workflow, simply add a workflow to the `jobs.workflows` arr
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `slug` | Define a slug-based name for this workflow. This slug needs to be unique among both tasks and workflows. |
| `handler` | The function that should be responsible for running the workflow. You can either pass a string-based path to the workflow function file, or workflow job function itself. If you are using large dependencies within your workflow, you might prefer to pass the string path because that will avoid bundling large dependencies in your Next.js app. Passing a string path is an advanced feature that may require a sophisticated build pipeline in order to work. |
| `inputSchema` | Define the input field schema - payload will generate a type for this schema. |
| `inputSchema` | Define the input field schema - Payload will generate a type for this schema. |
| `interfaceName` | You can use interfaceName to change the name of the interface that is generated for this workflow. By default, this is "Workflow" + the capitalized workflow slug. |
| `label` | Define a human-friendly label for this workflow. |
| `queue` | Optionally, define the queue name that this workflow should be tied to. Defaults to "default". |