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.

class libtmux-ts latest

VersionTooLowError

A tmux too old for the operation, or a version libtmux does not recognize.

Source and package
Qualified name
VersionTooLowError
Module
errors
Package
libtmux
Source
packages/libtmux/src/errors.ts
class errors.VersionTooLowError

Description#

Constructed bare for parity with the Python library, which has this name and throws it with no message. Constructed with its parts by this package, so a caller filtering on a field their tmux predates is told which field, which release has it, and which release answered — rather than being handed an empty result that reads as "no object has this".

Every command refused for the minimum tmux release carries delivery of not_started and a remedy: upgrade tmux and restart the server, or pin the previous libtmux release.

Members9#

Common operations3#

  • criteriaName: string attribute The criteria key the caller wrote, when this came from a query.
  • serverVersion: string attribute The tmux that answered, when this came from a query.
  • since: string attribute The first tmux that has the field, when this came from a query.

Other members6#

  • code: LibTmuxErrorCode attribute
  • constructor method
  • delivery: DeliveryStatus attribute not_started when tmux was refused before the operation could run.
  • reason: string attribute What was refused, without the remedy: the message up to where remedy begins.
  • recognized: boolean attribute false when the server's report names no release libtmux can place, such as master, rather than one below the minimum.
  • remedy: string attribute What to do about it, when the refusal has a fix the caller controls.

Guides#

Pages that discuss VersionTooLowError.

Esc

Type to search.

Reference previewOpen reference