get | SignalWire

Retrieve a configuration value using a dot-notation path (e.g., 'server.port'). Prototype-pollution keys (__proto__, constructor, prototype) are blocked and return the default value.

Parameters

path

stringRequired

Dot-separated key path into the config object (e.g., "server.port", "security.ssl_enabled").

defaultValue

Value returned when the path does not exist.

Returns

T — The resolved value, or defaultValue if not found.

Example

1 import { ConfigLoader } from '@signalwire/sdk';
2 
3 const config = new ConfigLoader('./config.json');
4 
5 const port = config.get<number>('server.port', 3000);
6 const ssl = config.get<boolean>('security.ssl_enabled', false);
7 const user = config.get<string>('security.auth.basic.user', 'signalwire');
8 
9 console.log(`Port: ${port}, SSL: ${ssl}, User: ${user}`);

1	import { ConfigLoader } from '@signalwire/sdk';
2
3	const config = new ConfigLoader('./config.json');
4
5	const port = config.get<number>('server.port', 3000);
6	const ssl = config.get<boolean>('security.ssl_enabled', false);
7	const user = config.get<string>('security.auth.basic.user', 'signalwire');
8
9	console.log(`Port: ${port}, SSL: ${ssl}, User: ${user}`);