Skip to content

API reference

Use this page to find an exact API signature when a guide does not cover your case. The generated references describe documented public APIs at the version built by the site; check your installed package version when a signature differs.

The .NET API reference is generated with DocFX from the XML documentation comments across the Chronicle client SDK, Arc, and Fundamentals assemblies.

Browse the .NET API reference → — public types and members from the Chronicle clients, Arc (including Arc.Core and MongoDB), and Fundamentals, organized by namespace. Shared extension classes list their contributing assemblies; existing per-library type and member URLs redirect to the canonical pages.

XML comments also appear in IDE IntelliSense. Relevant NuGet packages include Cratis.Chronicle, Cratis.Arc, Cratis, Cratis.Testing, Cratis.Arc.MongoDB, and Cratis.Specifications.XUnit. Install only the packages your application needs.

The TypeScript API reference is generated with TypeDoc from the @cratis/* packages and surfaced alongside the rest of the site:

We deliberately combine tooling: a modern site for the narrative docs, and the best generator for each kind of API reference. The reference is built in the documentation pipeline from the product source — there’s nothing to hand-maintain. See the documentation site’s README.md for the build details.

  • Learning or solving a problem? Stay in the guides, tutorial, and scenarios — they explain the why and the how.
  • Looking up an exact signature? The API reference and your IDE’s IntelliSense are the fastest path.