Interface: PluginSetupContext<TState>

Context passed to plugin setup() function.

Type Parameters

Type Parameter	Default type
`TState`	`Record`<`string`, `unknown`>

Property	Modifier	Type	Description
`models`	`readonly`	`ModelInfo`[]	Information about all registered models.
`state`	`public`	`TState`	Plugin state - persists across middleware calls. Initialized as empty object, can be mutated by plugin.

getModel<T>(name): FlashcoreModel<T>

Get a model by name.

Type Parameter
`T` extends { `id`: `string`; }

Parameter	Type
`name`	`string`

hasModel(name): boolean

Check if a model with the given name is registered.

Parameter	Type
`name`	`string`

boolean

markModel(
   name, 
   key, 
   value): void

Mark a model with metadata (accessible via model.meta).

void

registerIndex(
   model, 
   field, 
   indexType): void

void

registerModel<T>(name, schema): FlashcoreModel<T>

Type Parameter
`T` extends { `id`: `string`; }

Parameter	Type
`name`	`string`
`schema`	`SchemaFields`