Interface: FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>

Defined in: types.ts:283

Represents a feature module that organizes state, logic, and dependencies for a specific part of an application.

Type Parameters

State

State = any

The type of the feature state slice.

ActionTypes

ActionTypes extends string = string

The union type of action type strings.

Actions

Actions extends Record<string, (...args) => Action<any>> = any

The shape of action creator functions.

Selectors

Selectors extends Record<string, (state) => any> = any

The shape of selector functions.

Dependencies

Dependencies = any

The type representing dependencies required by the feature.

Indexable

[key: string]: any

Properties

slice

readonly slice: string

Defined in: types.ts:291

A unique identifier string for the feature's state slice in the store.

---

initialState

readonly initialState: State

Defined in: types.ts:292

The initial state value for this feature slice.

---

dependencies?

readonly optional dependencies: Dependencies

Defined in: types.ts:293

---

loaded$

readonly loaded$: Subject<void>

Defined in: types.ts:294

---

destroyed$

readonly destroyed$: Subject<void>

Defined in: types.ts:295

---

data$

readonly data$: Streams<Selectors>

Defined in: types.ts:296

---

actions

readonly actions: Actions

Defined in: types.ts:297

An object containing action creator functions.

---

selectors

readonly selectors: Selectors

Defined in: types.ts:298

An object containing selector functions to derive data from the state.

---

init()

init: (store) => FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>

Defined in: types.ts:300

Parameters

store

Store<any>

Returns

FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>

---

configure()

configure: (store) => FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>

Defined in: types.ts:301

Parameters

store

Store<State>

Returns

FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>

---

destroy()

destroy: (clearState?) => FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>

Defined in: types.ts:302

Parameters

clearState?

boolean

Returns

FeatureModule<State, ActionTypes, Actions, Selectors, Dependencies>