getBasicAuthCredentials

Retrieve the current HTTP Basic Auth credentials used by this service. Every SWMLService instance has auth credentials — either explicitly provided in the constructor, read from environment variables, or auto-generated at startup.

Parameters

includeSource

booleanDefaults to false

When true, returns a 3-tuple that includes the credential source as the third element. The source is one of:

"provided" — credentials were passed through constructor options
"environment" — credentials came from SWML_BASIC_AUTH_USER and SWML_BASIC_AUTH_PASSWORD environment variables
"auto-generated" — credentials were randomly generated at startup

Returns

[string, string] — A [username, password] tuple when includeSource is false or omitted.

[string, string, 'provided' | 'environment' | 'auto-generated'] — A [username, password, source] tuple when includeSource is true.

Example

1 import { SWMLService } from '@signalwire/sdk';
2 
3 const service = new SWMLService({ name: 'my-service' });
4 
5 // Get credentials
6 const [username, password] = service.getBasicAuthCredentials();
7 console.log(`Auth: ${username}:${password}`);
8 
9 // Get credentials with source information
10 const [user, pass, source] = service.getBasicAuthCredentials(true);
11 console.log(`Auth source: ${source}`); // "provided", "environment", or "auto-generated"