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

SectionCovers
Trains and JunctionsTrain, ServiceTrain, Junction, EffectJunction, IRoute, MonadTask, Either, TrainException and the registration helpers
Train MethodsThe members that declare, run and read a chain: Junctions, Chain, the decision steps, Run, RunEither, DeclaredChain
AttributesEvery attribute Trax reads: [TraxAuthorize], [TraxAllowAnonymous], [TraxSensitive], [TraxRemote], [Inject] and the GraphQL exposure attributes
ConfigurationAddTrax, AddEffects, data providers, effect providers, junction effects, lifecycle hooks and broadcasters
State Machine APIAuthoring, hosting and persisting snapshot state machines: AddStateMachines, Machine<TState, TTrigger>, IMachineBuilder, StateMachineMutations, and the TypeScript package

Mediator and Scheduler

SectionCovers
Mediator APIITrainBus, train discovery and execution, concurrency limits, trusted execution scopes
Scheduler APIAddScheduler, ITraxScheduler, manifests, dead letters, remote and Lambda workers, scheduling helpers

Api

SectionCovers
GraphQL APIAddTraxGraphQL, the queries, mutations and subscriptions, query models and error codes
GraphQL ClientThe outbound client, with queries validated against the server's schema
Client APITrax.Client: TraxClient, TraxHttpTransport and GraphQLSubscriptionSocket, which send a host's persisted documents from .NET
Persisted OperationsRegistering, enforcing and managing persisted GraphQL operations
API AuthThe principal abstraction and the API-key, JWT, Cognito and OIDC schemes
API AuditThe request-level audit pipeline: entries, sinks, redactors, options

Dashboard

SectionCovers
API DashboardUseTraxApiDashboard and TraxApiDashboardOptions: the React operations dashboard a Trax.Api host serves over its GraphQL endpoint

Testing

SectionCovers
TestingThe test-support packages: architecture guards, database invariants, machine conformance