SDK Reference
Every public type and method a Trax package ships, one per page. Each page names its package, namespace and source files. For how the parts work, see Core, Effect and Mediator.
Core and Effect
| Section | Covers |
|---|
| Trains and Junctions | Train, ServiceTrain, Junction, EffectJunction, IRoute, MonadTask, Either, TrainException and the registration helpers |
| Train Methods | The members that declare, run and read a chain: Junctions, Chain, the decision steps, Run, RunEither, DeclaredChain |
| Attributes | Every attribute Trax reads: [TraxAuthorize], [TraxAllowAnonymous], [TraxSensitive], [TraxRemote], [Inject] and the GraphQL exposure attributes |
| Configuration | AddTrax, AddEffects, data providers, effect providers, junction effects, lifecycle hooks and broadcasters |
| State Machine API | Authoring, hosting and persisting snapshot state machines: AddStateMachines, Machine<TState, TTrigger>, IMachineBuilder, StateMachineMutations, and the TypeScript package |
Mediator and Scheduler
| Section | Covers |
|---|
| Mediator API | ITrainBus, train discovery and execution, concurrency limits, trusted execution scopes |
| Scheduler API | AddScheduler, ITraxScheduler, manifests, dead letters, remote and Lambda workers, scheduling helpers |
Api
| Section | Covers |
|---|
| GraphQL API | AddTraxGraphQL, the queries, mutations and subscriptions, query models and error codes |
| GraphQL Client | The outbound client, with queries validated against the server's schema |
| Client API | Trax.Client: TraxClient, TraxHttpTransport and GraphQLSubscriptionSocket, which send a host's persisted documents from .NET |
| Persisted Operations | Registering, enforcing and managing persisted GraphQL operations |
| API Auth | The principal abstraction and the API-key, JWT, Cognito and OIDC schemes |
| API Audit | The request-level audit pipeline: entries, sinks, redactors, options |
Dashboard
| Section | Covers |
|---|
| API Dashboard | UseTraxApiDashboard and TraxApiDashboardOptions: the React operations dashboard a Trax.Api host serves over its GraphQL endpoint |
Testing
| Section | Covers |
|---|
| Testing | The test-support packages: architecture guards, database invariants, machine conformance |