getProcessSize

getProcessSize (aliased as ps) reads the current terminal dimensions at the moment it is called, returning a TerminalDimensions object. For a one-time snapshot taken at import time, use the exported constant size instead.

Signature

function getProcessSize(): TerminalDimensions

// Static snapshot captured at module load time
const size: TerminalDimensions

Return Value

A TerminalDimensions object whose width and height properties each carry a TerminalSize with pre-computed og, half, third, twoThirds, and full values.

Aliases

Exported as both getProcessSize and ps.

Usage

import { getProcessSize } from "ts-better-console";

const dim = getProcessSize();
console.log("Terminal width:", dim.width.og);
console.log("Half width:", dim.width.half);