Skip to Content
This is documentation for Trrack 2.0. Click here for legacy Trrack documentation →
ClassesClass: Registry<Event>

@trrack/core


@trrack/core / Registry

Class: Registry<Event>

Defined in: registry/reg.ts:26 

Type Parameters

Event

Event extends string

Methods

get()

get(type): TrrackActionRegisteredObject

Defined in: registry/reg.ts:135 

Parameters

type

string

Returns

TrrackActionRegisteredObject


has()

has(name): boolean

Defined in: registry/reg.ts:37 

Parameters

name

string

Returns

boolean


register()

Call Signature

register<DoActionType, State, DoActionPayload>(type, actionFunction, config?): IsAny<DoActionPayload, ActionCreatorWithPayload<any, DoActionType>>

Defined in: registry/reg.ts:41 

Type Parameters
DoActionType

DoActionType extends string

State

State = any

DoActionPayload

DoActionPayload = any

Parameters
type

DoActionType

actionFunction

StateChangeFunction<State, DoActionPayload>

config?
eventType

Event

label

string | LabelGenerator<DoActionPayload>

Returns

IsAny<DoActionPayload, ActionCreatorWithPayload<any, DoActionType>>

Call Signature

register<DoActionType, UndoActionType, DoActionPayload, UndoActionPayload>(type, actionFunction, config?): IsAny<DoActionPayload, ActionCreatorWithPayload<any, DoActionType>>

Defined in: registry/reg.ts:53 

Type Parameters
DoActionType

DoActionType extends string

UndoActionType

UndoActionType extends string

DoActionPayload

DoActionPayload = any

UndoActionPayload

UndoActionPayload = any

Parameters
type

DoActionType

actionFunction

TrrackActionFunction<DoActionType, UndoActionType, UndoActionPayload, DoActionPayload>

config?
eventType

Event

label

string | LabelGenerator<DoActionPayload>

Returns

IsAny<DoActionPayload, ActionCreatorWithPayload<any, DoActionType>>

Call Signature

register<DoActionType, UndoActionType, DoActionPayload, UndoActionPayload, State>(type, actionFunction, config?): IsAny<DoActionPayload, ActionCreatorWithPayload<any, DoActionType>>

Defined in: registry/reg.ts:71 

Type Parameters
DoActionType

DoActionType extends string

UndoActionType

UndoActionType extends string

DoActionPayload

DoActionPayload = any

UndoActionPayload

UndoActionPayload = any

State

State = any

Parameters
type

DoActionType

actionFunction

TrrackActionFunction<DoActionType, UndoActionType, UndoActionPayload, DoActionPayload> | StateChangeFunction<State, DoActionPayload>

config?
eventType

Event

label

string | LabelGenerator<DoActionPayload>

Returns

IsAny<DoActionPayload, ActionCreatorWithPayload<any, DoActionType>>


create()

static create<Event>(): Registry<Event>

Defined in: registry/reg.ts:27 

Type Parameters

Event

Event extends string

Returns

Registry<Event>

Last updated on