Skip to main content

@w5s/task

W5S Task modules (@w5s/task)

NPM Version License

Installation​

npm install @w5s/task

Usage​

Example​

import { Task } from '@w5s/task';

function randomNumber() {
  return Task.create(({ ok }) => ok(Math.random()));
}

function log(value: unknown) {
  // This is a lazy operation that will only be evaluated when the Task is run
  return Task.create(({ ok }) => ok(console.log(value)));
}

// This function returns a task that will do nothing until Task.run is called on it
export function main() {
  // 1. Generate a random number
  const randomValueTask = randomNumber();
  // 2. Compute square value
  const squareValueTask = Task.map(randomValueTask, (value) => value * value);
  // 3. Log value in console
  return Task.andThen(squareValueTask, log);
}

// runTask is impure and should be put at the edge of the program
void Task.run(main()); // prints { _: 'Result/Ok', value: <random number> * <random number> }

License​

MIT © Julien Polo julien.polo@gmail.com

Index

Interfaces

Namespaces

Type Aliases

Type Aliases

TaskRunner

TaskRunner: <Value, Error>(task: TaskLike<Value, Error>, canceler: TaskCanceler) => Awaitable<Result<Value, Error>>

A function that runs the task and returns a @w5s/core!Result

Page Options