Default task

This is the way to create a default task.

There’s no concurrency management in this task and every perform will be executed immediately.

Usage

To specify a default task, you can either use the dot notation or the options notation.

Note

We call this tab “Dot notation” because you can define a default task with task.default. But it’s much easier and recommended to just use task.

Dot notation

import { task } from '@sheepdog/vanilla';

const myTask = task(async () => {
  // your code
});

Options notation

import { task } from '@sheepdog/vanilla';

const myTask = task(
  async () => {
    // your code
  },
  { kind: 'default' },
);

The task

The return value of the task function will be an object with getters where you can access state from all the instances running and eventually cancel them with cancelAll.

Task structure Take a look at the Task structure documentation in our Getting started

Passing props

While defining a task, if the function that you pass in has some arguments, those will be required by the perform function (and it will be strongly typed too).

Caution

If you need to pass multiple props you should use an object because the second parameter will always be the SheepdogUtils.

Dot notation

import { task } from '@sheepdog/vanilla';

const myTask = task(async (id: string) => {
  // your code
});

button.addEventListener('click', () => {
  myTask.perform('42');
});

Options notation

import { task } from '@sheepdog/vanilla';

const myTask = task(
  async (id: string) => {
    // your code
  },
  { kind: 'default' },
);

button.addEventListener('click', () => {
  myTask.perform('42');
});

Getting the return value

If you return something from your task you can access the return value by awaiting the perform function.

Dot notation

import { task } from '@sheepdog/vanilla';

const myTask = task(async () => {
  return 42;
});

button.addEventListener('click', () => {
  const number = await myTask.perform();
  console.log(number); // 42
});

Options notation

import { task } from '@sheepdog/vanilla';

const myTask = task(
  async () => {
    return 42;
  },
  { kind: 'default' },
);

button.addEventListener('click', () => {
  const number = await myTask.perform();
  console.log(number); // 42
});

Getting the TaskInstance

If you don’t await the perform function, then you’ll get back the task instance that you can use either to cancel it or to get its current state. The TaskInstance is also an object with getters you can access the current value with instance.value or register events on it with instance.on.

Dot notation

import { task } from '@sheepdog/vanilla';

const myTask = task(async () => {
  // your code
});

button.addEventListener('click', () => {
  const lastRun = myTask.perform();
  lastRun.on('success', () => {
    console.log(lastRun.value);
  });
  lastRun.cancel();
});

Options notation

import { task } from '@sheepdog/vanilla';

const myTask = task(
  async () => {
    // your code
  },
  { kind: 'default' },
);

button.addEventListener('click', () => {
  lastRun = myTask.perform();
  lastRun.on('success', () => {
    console.log(lastRun.value);
  });
  lastRun.cancel();
});

Tip

Since this kind of task does not do any concurrency management there’s no way to specify a max concurrency value.