async_hooks

Отключает экземпляр AsyncLocalStorage. Все последующие вызовы asyncLocalStorage.getStore() будут возвращать undefined до тех пор, пока снова не будет вызван asyncLocalStorage.run() или asyncLocalStorage.enterWith().

При вызове asyncLocalStorage.disable() будут завершены все текущие контексты, связанные с экземпляром.

Перед сборкой мусора для asyncLocalStorage необходимо вызвать asyncLocalStorage.disable(). Это не относится к хранилищам, предоставляемым asyncLocalStorage, поскольку такие объекты собираются вместе с соответствующими асинхронными ресурсами.

Используйте этот метод, когда asyncLocalStorage больше не используется в текущем процессе.

Переключается в контекст на оставшуюся часть текущего синхронного выполнения, а затем сохраняет хранилище при всех последующих асинхронных вызовах.

Пример:

const store = { id: 1 };
// Replaces previous store with the given store object
asyncLocalStorage.enterWith(store);
asyncLocalStorage.getStore(); // Returns the store object
someAsyncOperation(() => {
  asyncLocalStorage.getStore(); // Returns the same object
});

Этот переход будет действовать в течение всего синхронного выполнения. Это означает, что если, например, контекст был открыт в обработчике события, последующие обработчики событий также будут выполняться в этом контексте, если только они явно не привязаны к другому контексту с помощью AsyncResource. Поэтому следует предпочитать run() вместо enterWith(), если только нет веских причин использовать последний метод.

const store = { id: 1 };

emitter.on('my-event', () => {
  asyncLocalStorage.enterWith(store);
});
emitter.on('my-event', () => {
  asyncLocalStorage.getStore(); // Returns the same object
});

asyncLocalStorage.getStore(); // Returns undefined
emitter.emit('my-event');
asyncLocalStorage.getStore(); // Returns the same object

Синхронно выполняет функцию вне контекста и возвращает ее результат. Хранилище недоступно внутри функции обратного вызова и асинхронных операций, созданных внутри нее. Любой вызов getStore() внутри функции обратного вызова всегда будет возвращать undefined.

Необязательные аргументы args передаются функции обратного вызова.

Если функция обратного вызова выбрасывает ошибку, exit() также выбрасывает эту ошибку. Этот вызов не влияет на трассировку стека, а контекст восстанавливается.

Пример:

// Within a call to run
try {
  asyncLocalStorage.getStore(); // Returns the store object or value
  asyncLocalStorage.exit(() => {
    asyncLocalStorage.getStore(); // Returns undefined
    throw new Error();
  });
} catch (e) {
  asyncLocalStorage.getStore(); // Returns the same object or value
  // The error will be caught here
}

Возвращает текущее хранилище. Если вызван вне асинхронного контекста, инициализированного вызовом asyncLocalStorage.run() или asyncLocalStorage.enterWith(), возвращает undefined.

Синхронно выполняет функцию в контексте и возвращает ее результат. Хранилище недоступно вне функции обратного вызова. Оно доступно для любых асинхронных операций, созданных внутри функции обратного вызова.

Необязательные аргументы args передаются функции обратного вызова.

Если функция обратного вызова выбрасывает ошибку, run() также выбрасывает эту ошибку. Этот вызов не влияет на трассировку стека, а контекст закрывается.

Пример:

const store = { id: 2 };
try {
  asyncLocalStorage.run(store, () => {
    asyncLocalStorage.getStore(); // Returns the store object
    setTimeout(() => {
      asyncLocalStorage.getStore(); // Returns the store object
    }, 200);
    throw new Error();
  });
} catch (e) {
  asyncLocalStorage.getStore(); // Returns undefined
  // The error will be caught here
}

Привязывает указанную функцию к текущему контексту выполнения.

Сохраняет текущий контекст выполнения и возвращает функцию, принимающую функцию в качестве аргумента. При каждом вызове возвращенная функция вызывает переданную ей функцию в сохраненном контексте.

const asyncLocalStorage = new AsyncLocalStorage();
const runInAsyncScope = asyncLocalStorage.run(123, () => AsyncLocalStorage.snapshot());
const result = asyncLocalStorage.run(321, () => runInAsyncScope(() => asyncLocalStorage.getStore()));
console.log(result);  // returns 123

AsyncLocalStorage.snapshot() может заменить AsyncResource для простого отслеживания асинхронного контекста, например:

class Foo {
  #runInAsyncScope = AsyncLocalStorage.snapshot();

  get() { return this.#runInAsyncScope(() => asyncLocalStorage.getStore()); }
}

const foo = asyncLocalStorage.run(123, () => new Foo());
console.log(asyncLocalStorage.run(321, () => foo.get())); // returns 123

AsyncResource() предназначен для расширения. Создание экземпляра AsyncResource() также вызывает init. Если triggerAsyncId не указан, используется async_hook.executionAsyncId().

Привязывает указанную функцию к области действия этого AsyncResource.

Вызывает все хуки destroy. Этот метод следует вызывать только один раз. При повторном вызове будет выброшена ошибка. Его необходимо вызвать вручную. Если сборщик мусора удалит ресурс, хуки destroy вызваны не будут.

Вызывает переданную функцию с указанными аргументами в контексте выполнения асинхронного ресурса. Метод устанавливает контекст, запускает обратные вызовы AsyncHooks before, вызывает функцию, запускает обратные вызовы AsyncHooks after, а затем восстанавливает исходный контекст выполнения.

Привязывает указанную функцию к текущему контексту выполнения.

Включает обратные вызовы указанного экземпляра AsyncHook. Если обратные вызовы не заданы, включение ничего не делает.

Отключает обратные вызовы указанного экземпляра AsyncHook в общем пуле обратных вызовов AsyncHook, предназначенных для выполнения. После отключения хук не будет вызываться, пока его снова не включат.

Идентификатор контекста выполнения, создавшего это асинхронное событие.

Отключает автоматический вызов emitDestroy при сборке мусора для объекта. Обычно этот параметр не требуется задавать (даже если emitDestroy вызывается вручную), кроме случаев, когда извлекается asyncId ресурса и вместе с ним вызывается emitDestroy чувствительного API.

Вызывается при создании экземпляра класса, который может инициировать асинхронное событие.

При запуске асинхронной операции или ее завершении вызывается обратный вызов, уведомляющий пользователя. Обратный вызов before вызывается непосредственно перед указанным обратным вызовом.

Вызывается сразу после завершения обратного вызова, указанного в before.

Если во время выполнения обратного вызова возникает необработанное исключение, after запускается после отправки события 'uncaughtException' или выполнения обработчика domain.

Вызывается при вызове resolve() для промиса. Это может происходить не в том же идентификаторе выполнения, что и сам промис.

Вызывается после уничтожения ресурса, соответствующего asyncId