# TerminalOutputProbe

Source: /tuil/docs/reference/packages/core/api/terminal-output-probe
Locale: en

interface exported by @mwillbanks/tuil-core.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-core`.

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

## Members [#members]

| Member          | Type                          | Required | Description                                                                 | Related types |
| --------------- | ----------------------------- | -------- | --------------------------------------------------------------------------- | ------------- |
| `isTTY`         | `boolean \| undefined`        | No       | The `isTTY` member uses the `boolean \| undefined` contract.                | —             |
| `columns`       | `number \| undefined`         | No       | The `columns` member uses the `number \| undefined` contract.               | —             |
| `rows`          | `number \| undefined`         | No       | The `rows` member uses the `number \| undefined` contract.                  | —             |
| `getColorDepth` | `(() => number) \| undefined` | No       | The `getColorDepth` member uses the `(() => number) \| undefined` contract. | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/core/src/terminal.ts)

## Package [#package]

[@mwillbanks/tuil-core](/tuil/docs/reference/packages/core)