Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

function libtmux-ts latest

isTmuxName

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

Source and package
Qualified name
isTmuxName
Module
types
Package
libtmux
Source
packages/libtmux/src/types.ts
function isTmuxName(value: unknown): value is string

Description#

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 from the call it fed.

Examples#

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

Type to search.

Reference previewOpen reference