Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Process

Hierarchy

Index

Properties

Methods

Properties

allowedNodeEnvironmentFlags

allowedNodeEnvironmentFlags: ReadonlySet<string>

The process.allowedNodeEnvironmentFlags property is a special, read-only Set of flags allowable within the [NODE_OPTIONS][] environment variable.

arch

arch: string

argv

argv: string[]

argv0

argv0: string

config

config: object

Type declaration

  • target_defaults: object
    • cflags: any[]
    • default_configuration: string
    • defines: string[]
    • include_dirs: string[]
    • libraries: string[]
  • variables: object
    • clang: number
    • host_arch: string
    • node_install_npm: boolean
    • node_install_waf: boolean
    • node_prefix: string
    • node_shared_openssl: boolean
    • node_shared_v8: boolean
    • node_shared_zlib: boolean
    • node_use_dtrace: boolean
    • node_use_etw: boolean
    • node_use_openssl: boolean
    • target_arch: string
    • v8_no_strict_aliasing: number
    • v8_use_snapshot: boolean
    • visibility: string

connected

connected: boolean

debugPort

debugPort: number

domain

domain: Domain

env

env: ProcessEnv

execArgv

execArgv: string[]

execPath

execPath: string

Optional exitCode

exitCode: number

features

features: object

Type declaration

  • debug: boolean
  • inspector: boolean
  • ipv6: boolean
  • tls: boolean
  • tls_alpn: boolean
  • tls_ocsp: boolean
  • tls_sni: boolean
  • uv: boolean

hrtime

hrtime: HRTime

Optional mainModule

mainModule: Module
deprecated

since v14.0.0 - use require.main instead.

pid

pid: number

platform

platform: Platform

ppid

ppid: number

release

release: ProcessRelease

Optional report

report: ProcessReport

Only available with --experimental-report

stderr

stderr: WriteStream & object

Can also be a tty.WriteStream, not typed due to limitations.

stdin

stdin: ReadStream & object

stdout

stdout: WriteStream & object

Can also be a tty.WriteStream, not typed due to limitations.

title

title: string

traceDeprecation

traceDeprecation: boolean

version

version: string

versions

versions: ProcessVersions

Methods

abort

  • abort(): never

  • Returns never

addListener

chdir

  • chdir(directory: string): void

  • Parameters

    • directory: string

    Returns void

cpuUsage

  • Parameters

    Returns CpuUsage

cwd

  • cwd(): string

  • Returns string

disconnect

  • disconnect(): void

  • Returns void

emit

  • emit(event: "beforeExit", code: number): boolean
  • emit(event: "disconnect"): boolean
  • emit(event: "exit", code: number): boolean
  • emit(event: "rejectionHandled", promise: Promise<any>): boolean
  • emit(event: "uncaughtException", error: Error): boolean
  • emit(event: "uncaughtExceptionMonitor", error: Error): boolean
  • emit(event: "unhandledRejection", reason: any, promise: Promise<any>): boolean
  • emit(event: "warning", warning: Error): boolean
  • emit(event: "message", message: any, sendHandle: any): this
  • emit(event: Signals, signal: Signals): boolean
  • emit(event: "newListener", eventName: string | symbol, listener: function): this
  • emit(event: "removeListener", eventName: string, listener: function): this
  • emit(event: "multipleResolves", listener: MultipleResolveListener): this

  • Parameters

    • event: "beforeExit"
    • code: number

    Returns boolean

  • Parameters

    • event: "disconnect"

    Returns boolean

  • Parameters

    • event: "exit"
    • code: number

    Returns boolean

  • Parameters

    • event: "rejectionHandled"
    • promise: Promise<any>

    Returns boolean

  • Parameters

    • event: "uncaughtException"
    • error: Error

    Returns boolean

  • Parameters

    • event: "uncaughtExceptionMonitor"
    • error: Error

    Returns boolean

  • Parameters

    • event: "unhandledRejection"
    • reason: any
    • promise: Promise<any>

    Returns boolean

  • Parameters

    • event: "warning"
    • warning: Error

    Returns boolean

  • Parameters

    • event: "message"
    • message: any
    • sendHandle: any

    Returns this

  • Parameters

    Returns boolean

  • Parameters

    • event: "newListener"
    • eventName: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "removeListener"
    • eventName: string
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    Returns this

emitWarning

  • emitWarning(warning: string | Error, name?: string, ctor?: Function): void

  • Parameters

    • warning: string | Error
    • Optional name: string
    • Optional ctor: Function

    Returns void

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

exit

  • exit(code?: number): never

  • Parameters

    • Optional code: number

    Returns never

getMaxListeners

  • getMaxListeners(): number

getegid

  • getegid(): number

  • Returns number

geteuid

  • geteuid(): number

  • Returns number

getgid

  • getgid(): number

  • Returns number

getgroups

  • getgroups(): number[]

  • Returns number[]

getuid

  • getuid(): number

  • Returns number

hasUncaughtExceptionCaptureCallback

  • hasUncaughtExceptionCaptureCallback(): boolean

  • Returns boolean

kill

  • kill(pid: number, signal?: string | number): true

  • Parameters

    • pid: number
    • Optional signal: string | number

    Returns true

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

memoryUsage

  • Returns MemoryUsage

nextTick

  • nextTick(callback: Function, ...args: any[]): void

  • Parameters

    • callback: Function
    • Rest ...args: any[]

    Returns void

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

once

openStdin

  • Returns Socket

prependListener

prependOnceListener

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resourceUsage

  • Returns ResourceUsage

Optional send

  • send(message: any, sendHandle?: any, options?: object, callback?: function): boolean

  • Parameters

    • message: any
    • Optional sendHandle: any
    • Optional options: object
      • Optional swallowErrors?: boolean
    • Optional callback: function
        • (error: Error | null): void

        • Parameters

          Returns void

    Returns boolean

setMaxListeners

  • setMaxListeners(n: number): this

setUncaughtExceptionCaptureCallback

  • setUncaughtExceptionCaptureCallback(cb: function | null): void

  • Parameters

    • cb: function | null

    Returns void

setegid

  • setegid(id: number | string): void

  • Parameters

    • id: number | string

    Returns void

seteuid

  • seteuid(id: number | string): void

  • Parameters

    • id: number | string

    Returns void

setgid

  • setgid(id: number | string): void

  • Parameters

    • id: number | string

    Returns void

setgroups

  • setgroups(groups: ReadonlyArray<string | number>): void

  • Parameters

    • groups: ReadonlyArray<string | number>

    Returns void

setuid

  • setuid(id: number | string): void

  • Parameters

    • id: number | string

    Returns void

umask

  • umask(): number
  • umask(mask: string | number): number
  • deprecated

    since v14.0.0 - Calling process.umask() with no argument causes the process-wide umask to be written twice. This introduces a race condition between threads, and is a potential security vulnerability. There is no safe, cross-platform alternative API.

    Returns number

  • Can only be set if not in worker thread.

    Parameters

    • mask: string | number

    Returns number

uptime

  • uptime(): number

  • Returns number

Generated using TypeDoc