On this page

types.isTmuxName

Module: types
Package: @libtmux/libtmux
Source: packages/libtmux/src/types.ts

isTmuxName ( value : : unknown ) → value is string function [source] ¶ function [source] ¶ isTmuxName

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

Examples

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

0 declared, 0 inherited