Interface SerialConstructor<TFn>Copy item path

Options for serial function

serial is an async event wrapper that is cancelled when a new one starts. When a new event is started, the previous caller will receive a cancellation error, instead of being hung up indefinitely.

If you want every caller to receive the latest result instead of a cancellation error, use latest instead.

Example

import { serial } from "@pistonite/pure/sync";

// helper function to simulate async work
const wait = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));

// Create the wrapped function
const execute = serial({
    // This has to be curried for type inferrence
    fn: (checkCancel) => async () => {
        for (let i = 0; i < 10; i++) {
            await wait(1000);
            // The cancellation mechanism throws an error if is cancelled
            checkCancel();
        }
        return 42;
    }
});

// execute it the first time
const promise1 = execute();
await wait(3000);

// calling event.run a second time will cause `checkCancel` to return false
// the next time it's called by the first event
const promise2 = execute();

console.log(await promise1); // { err: "cancel" }
console.log(await promise2); // { val: 42 }
Copy

Passing in arguments

TypeScript magic is used to ensure full type-safety when passing in arguments.

import { serial, type SerialCancelToken } from "@pistonite/pure/sync";
import type { Result } from "@pistonite/pure/result";

const execute = serial({
   fn: (checkCancel) => async (arg1: number, arg2: string) => {

       // do something with arg1 and arg2
       console.log(arg1, arg2);

       // ...
   }
});

expectTypeOf(execute)
    .toEqualTypeOf<
        (arg1: number, arg2: string) => Promise<Result<void, SerialCancelToken>>
     >();

await execute(42, "hello"); // no type error!
Copy

Getting the current serial number

The serial number has type bigint and is incremented every time run is called.

You can have an extra argument after checkCancel, that will receive the current serial number, if you need it for some reason.

import { serial } from "@pistonite/pure/sync";

const execute = serial({
    fn: (checkCancel, serial) => () => { console.log(serial); }
});

await execute(); // 1n
await execute(); // 2n
Copy

Checking for cancel

It's the event handler's responsibility to check if the event is cancelled by calling the checkCancel function. This function will throw if the event is cancelled, and the error will be caught by the wrapper and returned as an Err

Note that even if you don't check it, there is one final check before the result is returned. So you will never get a result from a cancelled event. Also note that you only need to check after any await calls. If there's no await, everything is executed synchronously, and it's theoretically impossible to cancel the event. However, this depends on the runtime's implementation of promises.

Handling cancelled event

To check if an event is completed or cancelled, simply await on the promise check the err

import { serial } from "@pistonite/pure/sync";

const execute = serial({
    fn: (checkCancel) => async () => {
        // your code here ...
    }
});
const result = await execute();
if (result.err === "cancel") {
    console.log("event was cancelled");
} else {
    console.log("event completed");
}
Copy

You can also pass in a callback to the constructor, which will be called when the event is cancelled. The cancel callback is guaranteed to only fire at most once per run

import { serial } from "@pistonite/pure/sync";

const onCancel = (current: bigint, latest: bigint) => {
    console.log(`Event with serial ${current} is cancelled because the latest serial is ${latest}`);
};

const execute = new Serial({
    fn: ...,
    onCancel,
});
Copy

Exception handling

If the underlying function throws, the exception will be re-thrown to the caller.