ReactiveSetup

source

Function type Reactive Adapter's first argument setup

interface ReactiveSetup<Instance extends [ReactiveSubscribe](../../Reactive-Decorator/Function/ReactiveSubscribe)<Record>, State extends Record<string, any> = [ReactiveState](../Type/ReactiveState)<Instance>, Methods extends keyof Partial<Instance> = never, Props = any, Events extends Record<string, any> = {}>

Methods

emit

Trigger events directly externally.

getProps

Get external props.

on

Register events defined between Mounted and Init Lifecycle.

onDestroy

Register hooks to occur in Destroy Lifecycle.

onInit

Register hooks to occur in Init Lifecycle.

onMounted

Register hooks that will occur in Mounted Lifecycle.

setEvents

Set the events to be exposed.

setInitialState

Set the first Initial state.
Do not set the return value if it exists.

setMethods

Sets the functions to be exposed in the instance.

Methods

emit

emit

void

emit<EventName>(eventName: EventName, ...params: EventTriggerParams<Events, EventName>): void

Trigger events directly externally.

Parameters

eventName

EventName

params

EventTriggerParams<Events, EventName>

source

getProps

getProps

Props

getProps(): Props

Get external props.

source

on

on

void

on(callback: (<EventName>(instance: Instance, eventName: EventName, listener: ReactiveEventCallback<Events, EventName>) => void | (() => void))): void

Register events defined between Mounted and Init Lifecycle.

Parameters

callback

(<EventName>(instance: Instance, eventName: EventName, listener: ReactiveEventCallback<Events, EventName>) => void | (() => void))

source

onDestroy

onDestroy

void

onDestroy(callback: ((instance: Instance, props: Props) => void)): void

Register hooks to occur in Destroy Lifecycle.

Parameters

callback

((instance: Instance, props: Props) => void)

source

onInit

onInit

void

onInit(callback: ((instance: Instance, props: Props) => void)): void

Register hooks to occur in Init Lifecycle.

Parameters

callback

((instance: Instance, props: Props) => void)

source

onMounted

onMounted

void

onMounted(callback: ((props: Props, instance: null | Instance) => void | Instance)): void

Register hooks that will occur in Mounted Lifecycle.

Parameters

callback

((props: Props, instance: null | Instance) => void | Instance)

source

setEvents

setEvents

void

setEvents(events: readonly (keyof Events)[]): void

Set the events to be exposed.

Parameters

events

readonly (keyof Events)[]

source

setInitialState

setInitialState

void

setInitialState(state: State): void

Set the first Initial state.
Do not set the return value if it exists.

Parameters

state

State

source

setMethods

setMethods

void

setMethods(methods: readonly Methods[]): void

Sets the functions to be exposed in the instance.

Parameters

methods

readonly Methods[]

source