Alpha: Document API is currently alpha and subject to breaking changes.Back to full reference Canonical formatting mutation with boolean patch semantics.
| Operation | Member path | Mutates | Idempotency | Tracked | Dry run |
|---|---|---|---|---|---|
format.apply | format.apply | Yes | conditional | Yes | Yes |
format.fontSize | format.fontSize | Yes | conditional | No | Yes |
format.fontFamily | format.fontFamily | Yes | conditional | No | Yes |
format.color | format.color | Yes | conditional | No | Yes |
format.align | format.align | Yes | conditional | No | Yes |
Convenience aliases
| Alias method | Canonical operation | Behavior |
|---|---|---|
editor.doc.format.bold(...) | format.apply | Convenience alias for format.apply with inline.bold: true. |
editor.doc.format.italic(...) | format.apply | Convenience alias for format.apply with inline.italic: true. |
editor.doc.format.underline(...) | format.apply | Convenience alias for format.apply with inline.underline: true. |
editor.doc.format.strikethrough(...) | format.apply | Convenience alias for format.apply with inline.strike: true. |