API Reference
This is the auto-generated API reference for CephalonEngine 0.1.0-preview — every public type in every shipped Cephalon.* package, with member docs (methods, properties, events) inlined on each type page.
How to navigate
Section titled “How to navigate”| You’re looking for | Use |
|---|---|
| A specific type by name | Type index — alphabetical, includes the kind (class, interface, record, struct, enum, delegate). |
| All types in a namespace | Namespace index — sorted by namespace; click any to see its types. |
| The full namespace tree | Open Cephalon and drill in via the sidebar. |
| Member docs (methods, props, events) | They live on the containing type page — see Member notes. |
Sections
Section titled “Sections”- Cephalon (root namespace) — every shipped namespace, hierarchical view.
- Namespace index — alphabetical namespace list (flat).
- Type index — alphabetical type list, with kind annotation.
- Member notes — why members live on the type page, not standalone.
Reference contract
Section titled “Reference contract”API pages describe the public contract of this version. Stability follows the per-package maturity label:
M3(adoption-ready) — surface frozen within the preview minor; additive only.M2(broad) — surface may evolve between preview minors.M1(narrow) — single-scenario surface; expect churn.Internal.*namespaces — not part of the public contract; may break without notice.
Per-package labels: Reference → Architecture → Maturity audit.
Adopter-friendly views
Section titled “Adopter-friendly views”The API reference is exhaustive. For browsable, use-case-first navigation:
- Reference → Components — every package grouped by domain (Hosts, Data, Eventing, Identity, …) with install commands + Engine:* config keys.
- Reference → Configuration — every
Engine:*configuration option with examples. - Technology overview — narrative tour with scenarios + tips.
Provenance
Section titled “Provenance”| Field | Value |
|---|---|
| Generator | docfx metadata → Markdown export |
| Source repository | https://github.com/Cephalon-Labs/CephalonEngine |
| Source ref | main |
| Source path | D:/SaaS/CephalonEngine/src |
| Generated at | 2026-05-19T18:35:30.585Z |
| Page count | 1633 total · 367 namespace · 1266 type |
Regenerate locally with
npm run sync-docs. Re-runs are idempotent — only thereference/api/andsource/directories are touched.