• BridgeConfiguration

Interface BridgeConfiguration

Export bridge types

interface BridgeConfiguration {
advertiser?: MDNSAdvertiser;
bind?: string | string[];
debugModeEnabled?: boolean;
disableIpc?: boolean;
env?: { DEBUG?: string; NODE_OPTIONS?: string };
firmwareRevision?: string;
hap?: boolean | BridgeHapConfig;
manufacturer?: string;
matter?: MatterConfig;
model?: string;
name: string;
pin: string;
port?: number;
serialNumber?: string;
setupID?: string;
username: string;
}

Index

Properties

advertiser?bind?debugModeEnabled?disableIpc?env?firmwareRevision?hap?manufacturer?matter?model?namepinport?serialNumber?setupID?username

Properties

Optionaladvertiser

advertiser?: MDNSAdvertiser

Optionalbind

bind?: string | string[]

OptionaldebugModeEnabled

debugModeEnabled?: boolean

OptionaldisableIpc

disableIpc?: boolean

Optionalenv

env?: { DEBUG?: string; NODE_OPTIONS?: string }

OptionalfirmwareRevision

firmwareRevision?: string

Optionalhap

hap?: boolean | BridgeHapConfig

HAP publishing config. Defaults to enabled when omitted.

The object form (BridgeHapConfig) is preferred. The bare boolean form (hap: false / hap: true) is the deprecated v2-beta shorthand, still accepted for back-compat and normalized to { enabled: <boolean> } by validateHapConfig. The type allows it so existing configs keep compiling.

Deprecated

Pass hap as a boolean is deprecated; use { enabled } instead.

Optionalmanufacturer

manufacturer?: string

Optionalmatter

matter?: MatterConfig

Optionalmodel

model?: string

name

name: string

pin

pin: string

Optionalport

port?: number

OptionalserialNumber

serialNumber?: string

OptionalsetupID

setupID?: string

4-character HomeKit setup ID (alphanumeric, e.g. "ABCD"). Validated at runtime.

username

username: string

Settings

Member Visibility

• Inherited

ThemeOSLightDark

On This Page

Properties advertiserbinddebugModeEnableddisableIpcenvfirmwareRevisionhapmanufacturermattermodelnamepinportserialNumbersetupIDusername