hap-fluent / FluentCharacteristicError

Class: FluentCharacteristicError

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

Error thrown when a characteristic get, set, or update operation fails.

Remarks

The context object contains:

• characteristic — display name of the failing characteristic.
• value — the value that was attempted (may be undefined for get failures).
• originalError — the underlying error from hap-nodejs, if any.

Pitfalls

• NEVER swallow this error silently in a Homebridge plugin — hap-nodejs expects onGet/onSet handlers to either resolve or reject with an HAPStatus error code. If you catch and re-throw a plain Error, HomeKit receives a generic failure status and may mark the accessory as "Not Responding".

Example

import { FluentCharacteristicError } from 'hap-fluent';

lightbulb.characteristics.brightness.onSet(async (value) => {
  try {
    await device.setBrightness(value);
  } catch (err) {
    throw new FluentCharacteristicError('Device unreachable', {
      characteristic: 'Brightness',
      value,
      originalError: err
    });
  }
});

Extends

• FluentError

Constructors

Constructor

new FluentCharacteristicError(message, context?): FluentCharacteristicError;

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

Parameters

Parameter	Type
message	string
context?	{ characteristic?: string; originalError?: unknown; value?: unknown; }
context.characteristic?	string
context.originalError?	unknown
context.value?	unknown

Returns

FluentCharacteristicError

Overrides

FluentError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
context?	readonly	Record<string, unknown>	-	FluentError.context	packages/hap-fluent/src/errors.ts:54
message	public	string	-	FluentError.message	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	FluentError.name	node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	FluentError.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.	FluentError.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

FluentError.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

FluentError.prepareStackTrace