# truncateTerminalText

Source: /tuil/docs/reference/packages/core/api/truncate-terminal-text
Locale: en

function exported by @mwillbanks/tuil-core.



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

## function [#function]

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

```ts
export function truncateTerminalText(value: string, columns: number): string;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member    | Type     | Required | Description                               | Related types |
| --------- | -------- | -------- | ----------------------------------------- | ------------- |
| `value`   | `string` | Yes      | Supplies the `value` value as `string`.   | —             |
| `columns` | `number` | Yes      | Supplies the `columns` value as `number`. | —             |

## Returns [#returns]

`string` — Returns a value that satisfies `string`.

Related types: —

## 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/text.ts)

## Package [#package]

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