Types

Client Types

ButtplugClientOptions

Configuration options for ButtplugClient.

ClientEventMap

Event map for the ButtplugClient emitter. Each key is an event name and its value is the payload type passed to listeners.

DeviceOutputOptions

Options for Device.output. Sends a raw OutputCommand to a specific feature on the device.

DeviceStopOptions

Options for Device.stop. Without any options, stops all features on the device.

Device Types

DeviceFeatures

Collection of normalized output and input features for a device.

OutputFeature

Normalized output feature with type, index, range, and optional duration range.

InputFeature

Normalized input feature with type, index, range, and command capabilities.

FeatureValue

Feature index paired with a scalar value, used for batch output commands.

RotationValue

Feature index paired with speed and direction for rotation commands.

PositionValue

Feature index paired with position and duration for timed movement commands.

Protocol Types

OutputType

Output actuator type string literal union. All supported output types:

type OutputType =
  | "Vibrate"
  | "Rotate"
  | "RotateWithDirection"
  | "Oscillate"
  | "Constrict"
  | "Spray"
  | "Temperature"
  | "Led"
  | "Position"
  | "HwPositionWithDuration";

InputType

Input sensor type string literal union. All supported input types:

type InputType =
  | "Battery"
  | "RSSI"
  | "Pressure"
  | "Button"
  | "Position";

OutputCommand

Discriminated union of output command payloads, keyed by actuator type. Each variant is a single-key object:

type OutputCommand =
  | { Vibrate: { Value: number } }
  | { Rotate: { Value: number } }
  | { RotateWithDirection: { Value: number; Clockwise: boolean } }
  | { Oscillate: { Value: number } }
  | { Constrict: { Value: number } }
  | { Spray: { Value: number } }
  | { Temperature: { Value: number } }
  | { Led: { Value: number } }
  | { Position: { Value: number } }
  | { HwPositionWithDuration: { Position: number; Duration: number } };

ServerInfo

Handshake response from the server with capabilities and timing requirements.

InputReading

Server message delivering a sensor reading from a device.

Pattern Types

PatternPlayOptions

Options for controlling pattern playback behavior.

PatternDescriptor

Discriminated union of pattern descriptors. Uses the type field to distinguish between preset and custom patterns.

type PatternDescriptor = PresetPattern | CustomPattern;

PresetPattern

Pattern descriptor that references a built-in preset by name.

CustomPattern

Pattern descriptor with user-defined keyframe tracks.

Track

A sequence of keyframes bound to a specific device feature.

Keyframe

A single animation keyframe with a target value, transition duration, and optional easing. A duration of 0 creates an instant jump to the value.

Easing

Easing curve identifier used for keyframe interpolation:

type Easing = "linear" | "easeIn" | "easeOut" | "easeInOut" | "step";

PatternInfo

Read-only snapshot of a running pattern, returned by PatternEngine.list().

PresetInfo

Metadata describing a built-in preset pattern.

StopReason

Reason a pattern was stopped, used in PatternPlayOptions.onStop callbacks:

type StopReason =
  | "manual"
  | "complete"
  | "timeout"
  | "error"
  | "disconnect"
  | "deviceRemoved";

Logger

Logger

Structured logging interface for Buttplug components. Supports hierarchical prefixes via child().

Two built-in implementations are exported:

• consoleLogger -- Writes to console with a [buttplug] prefix
• noopLogger -- Silently discards all messages (default)

import { ButtplugClient, consoleLogger } from "@zendrex/buttplug.js";

const client = new ButtplugClient("ws://localhost:12345", {
  logger: consoleLogger,
});

Related

• ButtplugClient -- client API reference
• Device -- device API reference
• PatternEngine -- pattern engine API reference
• Constants -- exported constant values