https://github.com/choojs/nanotask

Microtask queue scheduler for the browser
https://github.com/choojs/nanotask

Last synced: 4 months ago
JSON representation

Microtask queue scheduler for the browser

• Host: GitHub
• URL: https://github.com/choojs/nanotask
• Owner: choojs
• License: mit
• Created: 2017-04-04T22:38:35.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-03T11:48:00.000Z (over 6 years ago)
• Last Synced: 2024-04-14T04:03:43.099Z (8 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 47
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nanotask [![stability][0]][1]

[![npm version][2]][3] [![build status][4]][5]

[![downloads][8]][9] [![js-standard-style][10]][11]

Microtask queue scheduler for the browser. Falls back to

`window.requestAnimationFrame` in environments that don't allow

`MutationObserver` based scheduling.

The microtask queue is a set of tasks that runs at the end of the current frame

in the browser, before recalculating style and painting. This is analogous to

`process.nextTick()` in Node. There's no direct API for the microtask queue in

the browser, but using `document.MutationObserver` we can trick the browser

into running functions as part of the microtask queue. This is useful to create

tight, 60fps loops in the main browser thread.

## Usage

```js

var nanotask = require('nanotask')

var queue = nanotask()

queue(function () {

  console.log('resolved at the start of the next frame')

})

```

## API

### `queue = nanotask()`

Create a new Nanotask instance.

### `queue(fn)`

Queue a function on the browser's microtask queue.

## Installation

```sh

$ npm i nanotask

```

## License

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

[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square

[1]: https://nodejs.org/api/documentation.html#documentation_stability_index

[2]: https://img.shields.io/npm/v/nanotask.svg?style=flat-square

[3]: https://npmjs.org/package/nanotask

[4]: https://img.shields.io/travis/yoshuawuyts/nanotask/master.svg?style=flat-square

[5]: https://travis-ci.org/yoshuawuyts/nanotask

[6]: https://img.shields.io/codecov/c/github/yoshuawuyts/nanotask/master.svg?style=flat-square

[7]: https://codecov.io/github/yoshuawuyts/nanotask

[8]: http://img.shields.io/npm/dm/nanotask.svg?style=flat-square

[9]: https://npmjs.org/package/nanotask

[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square

[11]: https://github.com/feross/standard