# types.isTmuxName

- **Module:** types
- **Package:** libtmux
- **Language:** TypeScript
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-ts/blob/46cccfef2a546de55ce8b308249b8c76339089a0/packages/libtmux/src/types.ts#L235
- **Page:** https://libtmux.org/en/ts/latest/reference/types-istmuxname/

```
function isTmuxName(value: unknown): value is string
```

Test whether a value is a name every supported tmux stores unchanged.

The refusal the mutating calls apply, offered ahead of them so a caller
validating configuration can report the bad field rather than catching a
[`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) from the call it fed.

## Examples

```ts
import { isTmuxName } from "libtmux";
const value: unknown = "work";
const name = isTmuxName(value) ? value : undefined;
```

## Parameters

- `value` (`unknown`)