Installation

To install, run the following command with your preferred package manager.

npm

npm install @sheepdog/vanilla

yarn

yarn add @sheepdog/vanilla

pnpm

pnpm install @sheepdog/vanilla

bun

bun add @sheepdog/vanilla

Setup the Async Transform

Note

If you are using @sheepdog/vanilla in a Vite project this is the way we recommend using @sheepdog/vanilla but it is optional. To understand more about the Async Transform, check out the guide

The Async Transform is a Vite plugin so to set it up you need to modify your vite.config.{js|ts}

vite.config.ts

import { asyncTransform } from '@sheepdog/vanilla/vite';
import { defineConfig } from 'vitest/config';

export default defineConfig(({ mode }) => ({
  plugins: [
    asyncTransform(),
  ],
  // rest of your config
}));

And that’s it! You can now use async tasks with proper mid-run cancellation!

Remember: the Async Transform will only change your code in some very specific places, read more about it in the async transform explainer.