JavaScript task configuration

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
);

typescript
Copied
1
// my_tasks.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 because it isn't exported.
17
const mySecondTask = airplane.task(
18
  {...},
19
  async (params) => {...}
20
);

typescript
Copied
1
// my_tasks.airplane.ts
2
import airplane from "airplane";
3

4
// You can share code between tasks by defining it outside of the task implementation function.
5
const getAirplaneTaskName = (slug) => `Airplane task ${slug}`;
6

7
// But be careful! This code will be executed when you run `airplane deploy`.
8
makeApiCall();
9

10
export default airplane.task(
11
  { slug: "my_task", name: getAirplaneTaskName("my_task") },
12
  // Task implementation
13
  async () => {
14
    console.log("Hello World!");
15
  },
16
);

typescript
Copied
1
parameters: {
2
  id: {
3
    type: "shorttext",
4
    name: "The team's ID",
5
  },
6
}

typescript
Copied
1
parameters: {
2
  // The slug and name of the parater are "id".
3
  id: "shorttext",
4
}

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
);

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
);

typescript
Copied
1
import airplane from "airplane";
2

3
export default airplane.task(
4
  {
5
    slug: "my_task",
6
    permissions: {
7
      viewers: { groups: ["support"] },
8
      executers: { users: ["jordan@airplane.dev"] },
9
    },
10
  },
11
  async (params) => {...}
12
);

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
);

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
);

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 ]+$"

yaml
Copied
1
options:
2
- Alfred Pennyworth
3
- Bruce Wayne
4
- label: BW
5
  value: Bruce Wayne

yaml
Copied
1
constraints:
2
  aws-region: us-west-2

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

yaml
Copied
1
resources:
2
  db: prod_postgres_db

yaml
Copied
1
resources:
2
  - prod_postgres_db
3
  - prod_rest_api

yaml
Copied
1
permissions: "team_access"

yaml
Copied
1
permissions:
2
  viewers:
3
    groups:
4
      - customer_success
5
    users:
6
      - success@airplane.dev
7
  requesters:
8
    groups:
9
      - support
10
    users:
11
      - support@airplane.dev
12
  executers:
13
    groups:
14
      - devs
15
  admins:
16
    groups:
17
      - team_admins

yaml
Copied
1
node:
2
  entrypoint: my_task.ts
3
  nodeVersion: "18"

yaml
Copied
1
entrypoint: my_folder/my_task.ts

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