tuil
ReferencePackages@mwillbanks/tuil-coreAPI

TerminalOutputProbe

interface exported by @mwillbanks/tuil-core.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-core.

export interface TerminalOutputProbe {
  readonly isTTY?: boolean;
  readonly columns?: number;
  readonly rows?: number;
  getColorDepth?(): number;
}

Members

MemberTypeRequiredDescriptionRelated types
isTTYboolean | undefinedNoThe isTTY member uses the boolean | undefined contract.
columnsnumber | undefinedNoThe columns member uses the number | undefined contract.
rowsnumber | undefinedNoThe rows member uses the number | undefined contract.
getColorDepth(() => number) | undefinedNoThe getColorDepth member uses the (() => number) | undefined contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-core

On this page