Skip to main content

Interface: ProcessAPI

Defined in: packages/core/src/runtime.ts:225

Process operations interface

Remarks

Subset of Node.js process global used for:

  • I/O streams (stdin/stdout/stderr)
  • Environment variables (TERM, EDITOR, HOME, etc.)
  • Process events (exit, SIGTSTP, etc.)
  • Platform detection (platform, arch)

Examples

const runtime = getRuntime();
const { Readable, Writable } = runtime.utils.stream;

const readable = new Readable();
readable.push('Hello\n');
readable.push(null);
readable.pipe(runtime.process.stdout);
const runtime = getRuntime();
const term = runtime.process.env.TERM || 'xterm-256color';
const editor = runtime.process.env.EDITOR || 'vi';
const home = runtime.process.env.HOME || '/';

Properties

stdin

stdin: ReadStream & object

Defined in: packages/core/src/runtime.ts:226

Type Declaration

fd

fd: 0


stdout

stdout: WriteStream & object

Defined in: packages/core/src/runtime.ts:227

Type Declaration

fd

fd: 1


stderr

stderr: WriteStream & object

Defined in: packages/core/src/runtime.ts:228

Type Declaration

fd

fd: 2


platform

platform: Platform

Defined in: packages/core/src/runtime.ts:229


arch

arch: Architecture

Defined in: packages/core/src/runtime.ts:230


env

env: ProcessEnv

Defined in: packages/core/src/runtime.ts:231


cwd()

cwd: () => string

Defined in: packages/core/src/runtime.ts:232

Returns

string


exit()

exit: (code?) => never

Defined in: packages/core/src/runtime.ts:233

Parameters

code?

number

Returns

never


pid

pid: number

Defined in: packages/core/src/runtime.ts:234


title

title: string

Defined in: packages/core/src/runtime.ts:235


version

version: string

Defined in: packages/core/src/runtime.ts:236


on()

on: (event, listener) => any

Defined in: packages/core/src/runtime.ts:237

Parameters

event

string

listener

(...args) => void

Returns

any


once()

once: (event, listener) => any

Defined in: packages/core/src/runtime.ts:238

Parameters

event

string

listener

(...args) => void

Returns

any


removeListener()

removeListener: (event, listener) => any

Defined in: packages/core/src/runtime.ts:239

Parameters

event

string

listener

(...args) => void

Returns

any


listeners()

listeners: (event) => Function[]

Defined in: packages/core/src/runtime.ts:240

Parameters

event

string

Returns

Function[]


nextTick()

nextTick: (callback, ...args) => void

Defined in: packages/core/src/runtime.ts:241

Parameters

callback

Function

args

...any[]

Returns

void


kill()

kill: (pid, signal?) => boolean

Defined in: packages/core/src/runtime.ts:242

Parameters

pid

number

signal?

string | number

Returns

boolean