ratio

The ratio function converts a fraction string (Ratio) into an actual pixel/character count relative to a given total. It is used internally by Card widths but is also available for custom layout calculations.

Signature

function ratio(a: number, b: Ratio): number

Parameters

• a: The total (e.g. terminal column count).
• b: A Ratio fraction string — "1/2", "1/3", "2/3", or "full".

Return Value

A number equal to a × b. For "full" the original value is returned unchanged.

Usage

import { ratio, size } from "ts-better-console";

ratio(120, "1/2"); // 60
ratio(120, "1/3"); // 40
ratio(120, "2/3"); // 80
ratio(120, "full") // 120

// Combined with terminal size
const halfWidth = ratio(size.width.og, "1/2");