Socket
Socket
Sign inDemoInstall

immediate

Package Overview
Dependencies
0
Maintainers
1
Versions
31
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    immediate

A cross browser microtask library


Version published
Weekly downloads
10M
increased by4.27%
Maintainers
1
Install size
21.5 kB
Created
Weekly downloads
 

Package description

What is immediate?

The 'immediate' npm package is designed to execute functions asynchronously, as soon as possible, but outside of the current call stack. It uses a set of clever tricks to defer the execution of a function until the stack is clear. It is useful for scheduling tasks to run after the current event loop tick without the overhead of using setTimeout with a delay of 0.

What are immediate's main functionalities?

Asynchronous Execution

This feature allows you to schedule a function to be executed asynchronously, immediately after the current call stack is clear, but before the next event loop tick.

var immediate = require('immediate');
immediate(function () {
  console.log('Executed after the current event loop tick');
});

Other packages similar to immediate

Readme

Source

immediate Build Status

testling status

npm install immediate --save

then

var immediate = require("immediate");

immediate(function () {
  // this will run soon
});

immediate(function (arg1, arg2) {
  // get your args like in iojs
}, thing1, thing2);

Introduction

immediate is a microtask library, descended from NobleJS's setImmediate, but including ideas from Cujo's When and RSVP.

immediate takes the tricks from setImmediate and RSVP and combines them with the scheduler inspired (vaguely) by when's.

Note versions 2.6.5 and earlier were strictly speaking a 'macrotask' library not a microtask one, see this for the difference, if you need a macrotask library, I got you covered.

Several new features were added in versions 3.1.0 and 3.2.0 to maintain parity with process.nextTick, but the 3.0.x series is still being kept up to date if you just need the small barebones version

The Tricks

process.nextTick

Note that we check for actual Node.js environments, not emulated ones like those produced by browserify or similar.

queueMicrotask

Function available in major browser these days which you can use to add a function into the microtask queue managed by V8.

MutationObserver

This is what RSVP uses, it's very fast, details on MDN.

MessageChannel

Unfortunately, postMessage has completely different semantics inside web workers, and so cannot be used there. So we turn to MessageChannel, which has worse browser support, but does work inside a web worker.

<script> onreadystatechange

For our last trick, we pull something out to make things fast in Internet Explorer versions 6 through 8: namely, creating a <script> element and firing our calls in its onreadystatechange event. This does execute in a future turn of the event loop, and is also faster than setTimeout(…, 0), so hey, why not?

Tricks we don't use

setImmediate

We avoid using setImmediate because node's process.nextTick is better suited to our needs. Additionally, Internet Explorer 10's implementation of setImmediate is broken.

Reference and Reading

FAQs

Last updated on 09 Jun 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc