process

Расширения для объекта process.

Process: Основной, Рендер

Объект Electron's process расширен от объекта Node.js process. Он добавляет следующие события, свойства и методы:

Песочница​

В песочнице рендеров (sandboxed renderers) объект process содержит только подмножество API:

• crash()
• hang()
• getCreationTime()
• getHeapStatistics()
• getBlinkMemoryInfo()
• getProcessMemoryInfo()
• getSystemMemoryInfo()
• getSystemVersion()
• getCPUUsage()
• getIOCounters()
• uptime()
• argv
• execPath
• env
• pid
• arch
• platform
• sandboxed
• contextIsolated
• type
• version
• versions
• mas
• windowsStore
• contextId

События​

Событие: 'loaded'​

Выпускается, когда Electron загрузил свой внутренний скрипт инициализации и начинает загружать веб-страницу или основной скрипт.

Свойства​

process.defaultApp Только для чтения​

A boolean. Когда приложение запускается, передаваясь в качестве параметра в приложение по умолчанию, это свойство true в основном процессе, в противном случае оно undefined.

process.isMainFrame Только для чтения​

A boolean, true, когда текущий контекст рендера является фреймом рендера "main". Если вам нужен ID текущего фрейма, используйте webFrame.routingId.

process.mas Только для чтения​

A boolean. Для сборки из Mac App Store это свойство true, для других сборок оно undefined.

process.noAsar​

A boolean, управляющее поддержкой ASAR внутри вашего приложения. Установка этого значения в true отключит поддержку asar архивов в встроенных модулях Node.

process.noDeprecation​

A boolean, определяющее, будут ли предупреждения о устаревании выводиться в stderr. Установка этого значения в true отключит предупреждения о устаревании. Это свойство используется вместо командной строки --no-deprecation.

process.resourcesPath Только для чтения​

A string, представляющее путь к каталогу ресурсов.

process.sandboxed Только для чтения​

A boolean. Когда процесс рендера (renderer process) находится в песочнице (sandboxed), это свойство true, в противном случае undefined.

process.contextIsolated Только для чтения​

A boolean, указывающее, включен ли contextIsolation в текущем контексте рендера. В главном процессе он undefined.

process.throwDeprecation​

A boolean, управляющее тем, будут ли предупреждения о устаревании выбрасываться в виде исключений. Установка этого значения в true будет выбрасывать ошибки для устаревших вызовов. Это свойство используется вместо командной строки --throw-deprecation.

process.traceDeprecation​

A boolean, определяющее, будут ли следы стека включены в предупреждения об устаревании, выводимые в stderr. Установка этого значения в true выведет следы стека для предупреждений об устаревании. Это свойство используется вместо командной строки --trace-deprecation.

process.traceProcessWarnings​

A boolean, определяющее, будут ли следы стека включены в предупреждения процесса, выводимые в stderr. Установка этого значения в true выведет следы стека для предупреждений процесса (включая предупреждения об устаревании). Это свойство используется вместо командной строки --trace-warnings.

process.type Только для чтения​

A string, представляющее тип текущего процесса, может быть:

• browser - Основной процесс
• renderer - Процесс рендера
• worker - В веб-воркере

process.versions.chrome Только для чтения​

A string, представляющая строку версии Chrome.

process.versions.electron Только для чтения​

A string, представляющая строку версии Electron.

process.windowsStore Только для чтения​

A boolean. Если приложение работает как приложение Windows Store (appx), это свойство true, в противном случае undefined.

process.contextId Только для чтения​

A string (необязательно), представляющее глобально уникальный идентификатор текущего контекста JavaScript. Каждый фрейм имеет свой собственный контекст JavaScript. При включенном contextIsolation изолированный мир также имеет отдельный контекст JavaScript. Это свойство доступно только в процессе рендера.

Методы​

Объект process имеет следующие методы:

process.crash()​

Приводит к сбою главной нити текущего процесса.

process.getCreationTime()​

Возвращает number | null - число миллисекунд с начала эпохи, или null, если информация недоступна.

Указывает время создания приложения. Время представлено как число миллисекунд с начала эпохи. Возвращает null, если не удалось получить время создания процесса.

process.getCPUUsage()​

Возвращает CPUUsage

process.getIOCounters() Windows Linux​

Возвращает IOCounters

process.getHeapStatistics()​

Возвращает Object:

• totalHeapSize Целое число
• totalHeapSizeExecutable Целое число
• totalPhysicalSize Целое число
• totalAvailableSize Целое число
• usedHeapSize Целое число
• heapSizeLimit Целое число
• mallocedMemory Целое число
• peakMallocedMemory Целое число
• doesZapGarbage boolean

Возвращает объект со статистикой кучи V8. Обратите внимание, что все статистические данные сообщаются в килобайтах.

process.getBlinkMemoryInfo()​

Возвращает Object:

• allocated Целое число — размер всех выделенных объектов в килобайтах.
• total Целое число — общий выделенный объём в килобайтах.

Возвращает объект с информацией о памяти Blink. Может быть полезен для отладки проблем с памятью, связанными с рендерингом/DOM. Обратите внимание, что все значения указаны в килобайтах.

process.getProcessMemoryInfo()​

Возвращает Promise<ProcessMemoryInfo> — разрешает ProcessMemoryInfo

Возвращает объект, содержащий статистику использования памяти текущего процесса. Все значения указаны в килобайтах. Данный API следует вызывать после готовности приложения.

Chromium не предоставляет значение residentSet для macOS. Это связано с тем, что macOS выполняет сжатие страниц в памяти, которые не использовались в последнее время. В результате значение размера резидентного набора не соответствует ожиданиям. Значение private лучше отражает фактическое использование памяти процессом до сжатия на macOS.

process.getSystemMemoryInfo()​

Возвращает Object:

• total Целое число — общий объём физической памяти в килобайтах, доступной системе.
• free Целое число — общий объём памяти, не используемой приложениями или кэшем диска.
• swapTotal Целое число Windows Linux — общий объём памяти подкачки в килобайтах, доступной системе.
• swapFree Целое число Windows Linux — свободный объём памяти подкачки в килобайтах, доступной системе.

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

process.getSystemVersion()​

Возвращает string — версию операционной системы хоста.

Пример:

const version = process.getSystemVersion()
console.log(version)
// On macOS -> '10.13.6'
// On Windows -> '10.0.17763'
// On Linux -> '4.15.0-45-generic'

Примечание: Возвращает фактическую версию операционной системы вместо версии ядра на macOS, в отличие от os.release().

process.takeHeapSnapshot(filePath)​

• filePath Строка — Путь к выходному файлу.

Возвращает boolean — Указывает, был ли успешно создан снимок.

Создаёт снимок кучи V8 и сохраняет его в filePath.

process.hang()​

Приводит к зависанию главного потока текущего процесса.

process.setFdLimit(maxDescriptors) macOS Linux​

• maxDescriptors Целое число

Устанавливает мягкое ограничение на дескрипторы файлов для текущего процесса до maxDescriptors или до жёсткого ограничения ОС, в зависимости от того, какое из них меньше.