document

Read-only getter for the underlying SWML document object. Provides direct access to the mutable document (the returned reference is the internal object, not a copy). Equivalent to the Python SDK’s service property on SWMLBuilder.

Prefer getDocument() when you want an explicit method call for symmetry with other accessors. The document getter exists for callers that want property-style access.

Type

{ version: string; sections: Record<string, unknown[]> }

Example

1 import { SwmlBuilder } from '@signalwire/sdk';
2 
3 const builder = new SwmlBuilder();
4 builder.answer();
5 
6 console.log(builder.document.version); // "1.0.0"
7 console.log(builder.document.sections.main.length); // 1