@plures/praxis

---

@plures/praxis / index / defineModule

Function: defineModule()

defineModule<TContext>(options): PraxisModule<TContext>

Defined in: src/dsl/index.ts:202

Define a module (bundle of rules and constraints)

Type Parameters

TContext

TContext = unknown

Parameters

options

DefineModuleOptions<TContext>

Module options: optional rules, constraints, and meta

Returns

PraxisModule<TContext>

A PraxisModule with the given rules and constraints

Example

const authModule = defineModule({
  rules: [loginRule, logoutRule],
  constraints: [maxSessionsConstraint],
  meta: { version: "1.0.0" }
});