JavaScript task configuration

Configure a task's metadata as code
Task configuration defines the core metadata of an Airplane task; this includes all information like the task name and parameters aside from the actual code that is executed when the task is run.
While tasks can be initially configured in the Airplane UI, defining tasks as code is advantageous because it allows you to reap the benefits of version control; you can view the current state of a task and its history, subject tasks to the same code review and deploy mechanisms as the rest of your codebase, or roll back a task to a previous commit.
If you do edit the task configuration through the UI, you can run airplane tasks init --from your_task_slug to sync changes back to your code configuration.
Task configuration was previously accomplished using a yaml-based task definition. This new, inline task configuration allows tasks to be configured and developed in the same JavaScript file.
To migrate from a task definition to a single-file task configuration, run airplane tasks init --from=my_slug and then copy/paste the code body into the newly created .airplane.ts file.

Writing tasks

To define a task, the JavaScript SDK provides a function airplane.task(...), which takes two parameters: the task configuration and the task implementation.
typescript
Copied
1
// my_task.airplane.ts
2
import airplane from "airplane";
3
4
export default airplane.task(
5
// Task configuration
6
{
7
slug: "my_task",
8
name: "My Task",
9
description: "This is my task defined entirely in TypeScript!",
10
},
11
// Task implementation
12
async () => {
13
console.log("Hello World!");
14
}
15
);
Deploying this task creates an Airplane task that prints Hello World! when you run it.
All exported calls to airplane.task(...) will be discovered as tasks. You can even define multiple tasks in the same file by using either the default or named exports for each of your tasks.
Airplane will only discover tasks that are exported from files ending in .airplane.js, .airplane.ts, .airplane.jsx, or .airplane.tsx.
typescript
Copied
1
// myTasks.airplane.ts
2
import airplane from "airplane";
3
4
// Discoverable by Airplane
5
export default airplane.task(
6
{...},
7
async (params) => {...}
8
);
9
10
// Discoverable by Airplane
11
export const mySecondTask = airplane.task(
12
{...},
13
async (params) => {...}
14
);
15
16
// NOT discoverable by Airplane
17
const mySecondTask = airplane.task(
18
{...},
19
async (params) => {...}
20
);

Parameters

Parameters are specified in the task configuration as objects, where the key is the parameter slug and the value is the parameter configuration.
typescript
Copied
1
parameters: {
2
id: {
3
type: "shorttext",
4
name: "The team's ID",
5
},
6
}
You can also shorthand parameter configuration by setting the value to the parameter type. This defines a required parameter with slug and name equal to the key.
typescript
Copied
1
parameters: {
2
// The slug and name of the parater are "id".
3
id: "shorttext",
4
}
When you add parameters, you must change your implementation function to accept a params object. If you are using TypeScript, The params object is automatically typed based on your configuration!
The following is a full example of an inline task with parameters:
typescript
Copied
1
// my_task.airplane.ts
2
import airplane from "airplane";
3
4
export default airplane.task(
5
// Task configuration
6
{
7
slug: "my_task",
8
name: "My Task",
9
description: "This is my task defined entirely in JavaScript!",
10
parameters: {
11
// Required integer param with slug "my_int_param" and name "my_int_param"
12
my_int_param: "integer",
13
// Optional shorttext param with slug "my_optional_text_param" that defaults to "Hello!"
14
my_optional_text_param: {
15
type: "shorttext",
16
name: "My optional text param",
17
required: false,
18
default: "Hello!",
19
options: ["Hello!", "Good morning!"],
20
},
21
},
22
},
23
// The function takes a single argument, `params`, which is an object with the two params.
24
// e.g. { my_int_param: 3, my_optional_text_param: "Hello!" }
25
async (params) => {
26
console.log(`${params.my_optional_text_param}, ${params.my_int_param}`);
27
}
28
);

Examples

Attach a resource to a task and create a schedule

typescript
Copied
1
import airplane from "airplane";
2
3
export default airplane.task(
4
{
5
slug: "my_task",
6
parameters: {
7
text: "shorttext"
8
},
9
resources: {
10
// Attach the resource with slug "backend_db" under the alias "db"
11
db: "backend_db"
12
},
13
schedules: {
14
// Create a schedule for this task that runs at midnight each day
15
midnight_daily: {
16
cron: "0 0 * * *",
17
name: "Midnight daily",
18
description: "Runs at midnight each day",
19
paramValues: {
20
text: "text param value"
21
}
22
}
23
}
24
},
25
async (params) => {...}
26
);

Pass environment variables to a task and set label constraints for self-hosted agents

typescript
Copied
1
import airplane from "airplane";
2
3
export default airplane.task(
4
{
5
slug: "my_task",
6
envVars: {
7
// Pass an env var with a value
8
MY_ENV_VAR: "MY_ENV_VAR_VALUE",
9
// Pass an env var from a defined config var
10
MY_CONFIG_ENV_VAR: {config: "MY_CONFIG_ENV_VAR_VALUE"}
11
},
12
// Run only on agents with label "region:us-west-2"
13
constraints: {
14
region: "us-west-2"
15
}
16
},
17
async () => {...}
18
);

Require requests for task execution and set a custom timeout

typescript
Copied
1
import airplane from "airplane";
2
3
export default airplane.task(
4
{
5
slug: "my_task",
6
// Set a timeout of 200 seconds
7
timeout: 200,
8
// Require requests to execute
9
requireRequests: true,
10
allowSelfApprovals: false
11
},
12
async () => {...}
13
);

Reference

Task configuration

FieldTypeDefaultDescription
slugstringRequiredA unique identifier that ties this configuration to a task in Airplane. This cannot be changed (a different slug will end up creating a new task). Slugs must:
  • Be fewer than 50 characters long.
  • Use only lowercase letters, numbers and underscores.
  • Start with a lowercase later.
namestringSame value as slugA user-facing name for the task. This can be changed.
descriptionstringnullA user-facing description for the task. Supports markdown.
parametersParameter[]nullTasks can be configured with parameters that will be requested from users before they execute the task. Parameters are expressed as a mapping of slug to parameter. The values will be passed to your function as an object that maps the parameter slug to the corresponding value. For more information, see Parameter configuration.
requireRequestsbooleanfalseIf true, a task must be requested before it can start executing. This disables direct execution, including schedules.
allowSelfApprovalsbooleantrueIf true, a request can be approved by the requestor.
timeoutnumber (in seconds)3600 (1 hour)Limits how long a task can run before it is automatically cancelled. For more information, see timeouts.
constraintsRecord<string, string>nullRestricts this task to run only on agents with matching labels. For more information, see Run constraints.
schedulesRecord<string, Schedule>nullA map from schedule slug to a schedule that automatically runs the task on a recurring cadence. For more information, see Schedule configuration.
resourcesstring[] | Record<string, string>nullA list of resources to attach to this task. Once attached, a resource can be used to call Built-ins. The resource's fields can also be accessed via the AIRPLANE_RESOURCES environment variable. For more information, see resource attachments.
runtime"standard" | "workflow"standardThe runtime that the task is executed with. The workflow runtime is currently only supported by JavaScript tasks. For more information, see Runtimes.
envVarsRecord<string, string> | Record<string, {config: string}> | Record<string, {value: string}>nullEnvironment variables that will be passed into the task. For secrets or values that are shared across multiple tasks, environment variables can load their value from config variables.

Parameter configuration

FieldTypeDefaultDescription
typeshorttext | longtext | sql | boolean | integer | float | date | datetimeRequiredParameter type.
namestringParameter slugA human-readable name that identifies this parameter.
descriptionstringnullA description that renders underneath the parameter.
requiredbooleantrueWhether a non-empty value must be provided.
defaultstringnullThe initial value shown to users, also serves as the fallback if no value is provided.
regexRegExpnullA regular expression to validate the provided string value. Only valid for shorttext and longtext parameters.
optionsstring[] | {label: string, value: string}[]nullIf included, only values from the provided list will be accepted. An optional label can be provided for each option to override how these options are rendered in forms. Only valid for shorttext, longtext, sql, integer, float, date, and datetime parameters.

Schedule configuration

FieldTypeDefaultDescription
cronstringRequiredCron string of the schedule. To see acceptable formats, see Cron syntax.
namestringSchedule slugName of the schedule.
descriptionstringnullDescription of the schedule.
paramValuesRecord<string, value>nullMap of param slug to value to pass to the task on each run.

YAML reference (deprecated)

Task configuration was previously accomplished using a yaml-based task definition. We recommend migrating to the new, inline task configuration allows tasks to be configured and developed in the same JavaScript file.
To migrate from a task definition to a single-file task configuration, run airplane tasks init --from=my_slug and then copy/paste the code body into the newly created .airplane.ts file.

Standard fields

The fields below apply to all task definitions, regardless of the type of task.
slugstringREQUIRED
A unique identifier that ties this definition file to a task in Airplane. This cannot be changed (a different slug will end up creating a new task).
Slugs must:
  • Be fewer than 50 characters long
  • Use only lowercase letters, numbers, and underscores
  • Start with a lowercase letter
namestringREQUIRED
User-facing name for the task. This can be changed.
descriptionstringoptional
User-facing description for the task. This can be changed.
parameterslistoptional
A list of parameters. Each parameter is a user-facing field to input data into the task.
Example:
yaml
Copied
1
parameters:
2
- slug: name
3
name: Name
4
type: shorttext
5
description: The user's name.
6
default: Alfred Pennyworth
7
required: false
8
options:
9
- Alfred Pennyworth
10
- Bruce Wayne
11
regex: "^[a-zA-Z ]+$"
parameters.slugstringREQUIRED
Unique identifier for the parameter. This is the identifier you'll use to interpolate parameters into arguments, pass them when calling from the CLI, etc.
parameters.namestringREQUIRED
User-facing name for the parameter.
parameters.typeenumREQUIRED
Possible Values
shorttextYour commonly used string input
longtextA string, but with a larger input box for users
sqlSimilar to Long Text inputs but offer SQL syntax highlighting
booleanPresented as on/off toggles
uploadAllows users to upload a file
Show more
The type of the parameter. See Parameter types for more information.
User-facing description of the parameter.
parameters.requiredbooleanoptional
Default: true
Whether the parameter is required.
parameters.defaultstring/number/booleanoptional
The default value of the parameter. The type depends on the type of the parameter.
parameters.optionslist of string/number/boolean/objectoptional
Constrains the value of parameter to a list of options.
The type depends on the type of the parameter.
You can optionally add a label to each option. Labels are shown to the user instead of the value. To add a label, the option should be an object with fields label and value.
Example:
yaml
Copied
1
options:
2
- Alfred Pennyworth
3
- Bruce Wayne
4
- label: BW
5
value: Bruce Wayne
For more information, see Select options.
parameters.regexstringoptional
Allows you to more dynamically control what values are permitted. For more information, see Regular expressions.
requireRequestsbooleanoptional
Default: false
If true, a task must be requested before it can start executing. This disables direct execution, including schedules.
Requiring requests will disable schedules. Any existing schedules will be paused on the next attempted execution.
allowSelfApprovalsbooleanoptional
Default: true
If true, a request can be approved by the requestor.
timeoutnumber (in seconds)optional
Default: 3600 (1 hour)
Limits how long a task can run before it is automatically cancelled.
Maximum of 43200 (12 hours)
For more information, see timeouts.
constraintsobjectoptional
Restricts this task to run only on agents with matching labels.
Example:
yaml
Copied
1
constraints:
2
aws-region: us-west-2
For more information, see Run constraints.
schedulesobjectoptional
Mapping of unique identifiers to schedules that should be deployed with the task.
For more information, see Schedules.
Example:
yaml
Copied
1
schedules:
2
my_first_schedule:
3
cron: 0 0 * * *
4
name: My First Schedule
5
description: This is my first daily midnight UTC schedule!
6
paramValues:
7
my_first_param: my_first_param_value
The unique identifier is used to add, update and remove schedules as changes are made to the task definition file. Adding a new entry will create a new schedule, modifying an entry will update the schedule and removing an entry will pause the schedule.
The unique identifier must adhere to the slug format.
schedules.cronstringREQUIRED
Cron string of the schedule. To see acceptable formats, see Cron syntax.
schedules.namestringoptional
Name of the schedule.
schedules.descriptionstringoptional
Description of the schedule.
schedules.paramValuesobjectoptional
Map of param slugs and values to pass to the task on each run.
resourcesobjectoptional
Mapping of resource aliases to resource slugs. Slugs for your resource can be found in the resource settings.
For more information on resource attachments, see resource attachments.
Example:
yaml
Copied
1
resources:
2
db: prod_postgres_db
If you would like to use the resource slug as the alias for all resources passed into this task, you can also use a list shorthand:
yaml
Copied
1
resources:
2
- prod_postgres_db
3
- prod_rest_api
runtimeenumoptional
Possible Values
standard
workflow
The runtime that the task will execute within. Defaults to standard.
The workflow runtime is currently only supported by JavaScript tasks. For more information, see Runtimes.

JavaScript

nodeobjectoptional
Marks the task as a JavaScript task.
Example:
yaml
Copied
1
node:
2
entrypoint: my_task.ts
3
nodeVersion: "18"
node.entrypointstringREQUIRED
The path to the .ts or .js file containing the logic for this task. This can be absolute or relative to the location of the definition file.
Examples:
yaml
Copied
1
entrypoint: my_folder/my_task.ts
node.nodeVersionenumREQUIRED
Possible Values
14
16
18
The version of Node.js that the task should be executed with.
This field has no effect on tasks that use the workflow runtime. For more information, see Runtimes.
node.envVarsobjectoptional
Environment variables that will be passed into the task.
Environment variables can be entered directly ("from value"), or you can reference Config variables ("from config variable"). Use config variables for secrets and/or values you want to share across multiple tasks.
Example:
yaml
Copied
1
envVars:
2
# From value
3
NODE_ENV:
4
value: production
5
# From config variable
6
MY_SECRET:
7
config: MY_SECRET_CONFIG_VAR