hap-fluent / FluentError

Class: FluentError

Defined in: packages/hap-fluent/src/errors.ts:51

Base class for all HAP Fluent errors.

Remarks

FluentError captures the current stack trace at construction time via Error.captureStackTrace. It sets this.name to the concrete subclass name so that error.name is always human-readable in logs.

All FluentError subclasses carry an optional context record that you can log directly for structured diagnostics:

logger.error({ err, ...err.context }, 'HAP operation failed');

Use When

• Catching all hap-fluent errors in a single catch block (catch FluentError then narrow with instanceof for specific handling).

Avoid When

• Catching specific characteristic or service errors — use the subclasses FluentCharacteristicError, FluentServiceError, etc.

Example

import { FluentError, FluentCharacteristicError } from 'hap-fluent';

try {
  lightbulb.characteristics.brightness.set(200);
} catch (err) {
  if (err instanceof FluentCharacteristicError) {
    console.error('Characteristic error', err.context);
  } else if (err instanceof FluentError) {
    console.error('Generic fluent error', err.context);
  }
}

Extends

• Error

Extended by

• FluentCharacteristicError
• FluentServiceError
• ValidationError
• ConfigurationError

Constructors

Constructor

new FluentError(message, context?): FluentError;

Defined in: packages/hap-fluent/src/errors.ts:52

Parameters

Parameter	Type
message	string
context?	Record<string, unknown>

Returns

FluentError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
context?	readonly	Record<string, unknown>	-	-	packages/hap-fluent/src/errors.ts:54
message	public	string	-	Error.message	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	Error.name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	Error.stack	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076
stackTraceLimit	static	number	The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.	Error.stackTraceLimit	node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:67

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:55

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace