• 进程
    • Sandbox
    • 事件
      • 事件: 'loaded'
    • 属性
      • process.defaultApp
      • process.mas
      • process.noAsar
      • process.noDeprecation
      • process.resourcesPath
      • process.sandboxed
      • process.throwDeprecation
      • process.traceDeprecation
      • process.traceProcessWarnings
      • process.type
      • process.versions.chrome
      • process.versions.electron
      • process.windowsStore
    • 方法
      • process.crash()
      • process.getCreationTime()
      • process.getCPUUsage()
      • process.getIOCounters() Windows Linux
      • process.getHeapStatistics()
      • process.getProcessMemoryInfo()
      • process.getSystemMemoryInfo()
      • process.takeHeapSnapshot(filePath)
      • process.hang()
      • process.setFdLimit(maxDescriptors) macOS Linux

    进程

    处理对象的扩展

    参见: process, renderer process

    Electron's process 对象继承 Node.js process object。 它新增了以下事件、属性和方法

    Sandbox

    In sandboxed renderers the process object contains only a subset of the APIs:

    • crash()
    • hang()
    • getHeapStatistics()
    • getProcessMemoryInfo()
    • getSystemMemoryInfo()
    • getCPUUsage()
    • getIOCounters()
    • argv
    • execPath
    • env
    • pid
    • arch
    • platform
    • resourcesPath
    • 沙盒化
    • type
    • version
    • versions
    • mas
    • windowsStore

    事件

    事件: 'loaded'

    当Electron加载了它的内部初始化脚本并且是正要开始加载网页或主脚本时触发。

    当node集成被关闭时,预加载脚本可以使用它将删除的 Node global symbols 添加回全局范围:

    1. // preload.js
    2. const _setImmediate = setImmediate
    3. const _clearImmediate = clearImmediate
    4. process.once('loaded', () => {
    5. global.setImmediate = _setImmediate
    6. global.clearImmediate = _clearImmediate
    7. })

    属性

    process.defaultApp

    Boolean类型, 当作为参数传递给默认应用程序启动应用时,该属性在主进程中为true,否则为undefined

    process.mas

    Boolean类型,为 Mac App Store 生成, 此属性为 true, 对于其他生成,则为 undefined

    process.noAsar

    Boolean类型, 用于控制应用程序内的 ASAR 支持。将此设置为 true 将在Node的内置模块中禁用对 asar 的支持。

    process.noDeprecation

    Boolean 类型,用于控制弃用警告是否被打印到stderr。 将其设置为true将会禁用弃用警告。 使用此属性代替 -no-deprecation 命令行标志。

    process.resourcesPath

    String 类型, 表示资源目录的路径。

    process.sandboxed

    A Boolean. When the renderer process is sandboxed, this property is true, otherwise it is undefined.

    process.throwDeprecation

    Boolean类型,用于控制是否将弃用警告当做例外。 设置它为 true 时会抛出错误。 使用此属性代替 —throw-deprecation 命令行标志。

    process.traceDeprecation

    Boolean类型,用于控制打印到 stderr 的弃用中是否包含其堆栈跟踪。 将此设置为 true 将会打印对弃用的堆栈跟踪。 此属性代替 —trace-deprecation 命令行标志。

    process.traceProcessWarnings

    一个 Boolean, 用于控制是否将进程的警告打印到包含堆栈跟踪的 stderr中 。 将此设置为 true 将打印对进程警告的堆栈跟踪(包括弃用)。 此属性代替 —trace-warnings 命令行标志。

    process.type

    一个表示当前进程类型的 String, 可以是 "browser" (即主进程) 或 "renderer"

    process.versions.chrome

    string,一个表示 Chrome 版本的字符串。

    process.versions.electron

    string,一个表示 Electron 版本的字符串。

    process.windowsStore

    Boolean. 如果应用运行于 Windows 商店(appx), 改属性为true, 否则为 undefined.

    方法

    process 对象具有以下方法:

    process.crash()

    导致当前进程崩溃的主线程。

    process.getCreationTime()

    Returns Number | null - The number of milliseconds since epoch, or null if the information is unavailable

    Indicates the creation time of the application. The time is represented as number of milliseconds since epoch. It returns null if it is unable to get the process creation time.

    process.getCPUUsage()

    返回 CPUUsage

    process.getIOCounters() Windows Linux

    返回 IOCounters

    process.getHeapStatistics()

    返回 Object:

    • totalHeapSize Integer
    • totalHeapSizeExecutable Integer
    • totalPhysicalSize Integer
    • totalAvailableSize Integer
    • usedHeapSize Integer
    • heapSizeLimit Integer
    • mallocedMemory Integer
    • peakMallocedMemory Integer
    • doesZapGarbage Boolean
      Returns an object with V8 heap statistics. Note that all statistics are reported in Kilobytes.

    process.getProcessMemoryInfo()

    返回 Object:

    • residentSetIntegerLinuxWindows - 当前置顶的以 KB 为单位的物理内存数量。
    • private Integer - The amount of memory not shared by other processes, such as JS heap or HTML content in Kilobytes.
    • shared Integer - The amount of memory shared between processes, typically memory consumed by the Electron code itself in Kilobytes.
      Returns an object giving memory usage statistics about the current process. Note that all statistics are reported in Kilobytes. This api should be called after app ready.

    Chromium does not provide residentSet value for macOS. This is because macOS performs in-memory compression of pages that haven't been recently used. As a result the resident set size value is not what one would expect. private memory is more representative of the actual pre-compression memory usage of the process on macOS.

    process.getSystemMemoryInfo()

    返回 Object:

    • total Integer - 系统可用的物理内存总量(Kb)。
    • free Integer - 应用程序或磁盘缓存未使用的内存总量。
    • swapTotal Integer Windows__Linux - 系统交换内存容量(单位:千字节)。
    • swapFree Integer Windows__Linux - 系统可用交换内存大小(单位:千字节)。
      返回一个对象, 它提供有关当前进程的内存使用情况统计信息。请注意, 所有统计信息都以千字节为单位报告。

    process.takeHeapSnapshot(filePath)

    • filePath String - Path to the output file.
      Returns Boolean - Indicates whether the snapshot has been created successfully.

    Takes a V8 heap snapshot and saves it to filePath.

    process.hang()

    导致当前进程挂起的主线程。

    process.setFdLimit(maxDescriptors) macOS Linux

    • maxDescriptors Integer
      将文件描述符的软限制设置为 maxDescriptors 或 OS 硬限制, 其中以当前进程较低的值为准。