quicktask/readme.md

Tiny microtask queue scheduler for all environments

# Quicktask

> Tiny microtask queue scheduler for all environments

```bash
npm install --save quicktask
```

Inspired by `yoshuawuyts/nanotask`, this function manages a queue of microtasks, but focuses on being cross environment (not just browser) and with a tiny implementation. It returns a "scheduleMicrotask" helper.

- Uses `queueMicrotask` if available
- Otherwise uses `setImmediate` if available.
- Otherwise uses `process.nextTick` in Node.js.
- Otherwise uses `setTimeout` otherwise.

**Unless you need to support old runtimes or Internet Explorer, we recommend using `queueMicrotask` directly**. That said, this library is less than 1kB in size.

## Usage

In JavaScript / Node.js:

```js
const quicktask = require('quicktask').default;
const schedule = quicktask();

schedule(function () {
  console.log('resolved at the start of the next frame');
});
```

In TypeScript:

```typescript
import quicktask from 'quicktask';
const schedule = quicktask();

schedule(() => {
  console.log('resolved at the start of the next frame');
});
```

## API

### `const schedule = quicktask()`

Create a new Quicktask instance.

### `schedule(fn)`

Queue a function to run before the end of the current event loop.

## License

[MIT](https://tldrlegal.com/license/mit-license)