Class: StateDocsGenerator
August 8, 2026 ยท View on GitHub
@plures/praxis / index / StateDocsGenerator
Class: StateDocsGenerator
Defined in: src/integrations/state-docs.ts:131
Documentation generator for Praxis schemas
Constructors
Constructor
new StateDocsGenerator(
config):StateDocsGenerator
Defined in: src/integrations/state-docs.ts:134
Parameters
config
Returns
StateDocsGenerator
Methods
generateFromModule()
generateFromModule<
TContext>(module):GeneratedDoc[]
Defined in: src/integrations/state-docs.ts:184
Generate documentation from a Praxis registry
Type Parameters
TContext
TContext
Parameters
module
PraxisModule<TContext>
Returns
generateFromSchema()
generateFromSchema(
schema):GeneratedDoc[]
Defined in: src/integrations/state-docs.ts:154
Generate documentation from a Praxis schema