V8 API Reference Guide for node.js v9.10.0 - v9.11.1
Public Types | Public Member Functions | Static Public Member Functions | List of all members
v8::MicrotasksScope Class Reference

#include <v8.h>

Public Types

enum  Type { kRunMicrotasks, kDoNotRunMicrotasks }

Public Member Functions

 MicrotasksScope (Isolate *isolate, Type type)
 MicrotasksScope (const MicrotasksScope &)=delete
MicrotasksScopeoperator= (const MicrotasksScope &)=delete

Static Public Member Functions

static void PerformCheckpoint (Isolate *isolate)
static int GetCurrentDepth (Isolate *isolate)
static bool IsRunningMicrotasks (Isolate *isolate)

Detailed Description

This scope is used to control microtasks when kScopeMicrotasksInvocation is used on Isolate. In this mode every non-primitive call to V8 should be done inside some MicrotasksScope. Microtasks are executed when topmost MicrotasksScope marked as kRunMicrotasks exits. kDoNotRunMicrotasks should be used to annotate calls not intended to trigger microtasks.

Member Function Documentation

static int v8::MicrotasksScope::GetCurrentDepth ( Isolate isolate)

Returns current depth of nested kRunMicrotasks scopes.

static bool v8::MicrotasksScope::IsRunningMicrotasks ( Isolate isolate)

Returns true while microtasks are being executed.

static void v8::MicrotasksScope::PerformCheckpoint ( Isolate isolate)

Runs microtasks if no kRunMicrotasks scope is currently active.

The documentation for this class was generated from the following file: