Class IdleState

Hierarchy (View Summary)

TemplateState<TouchEventMapping, TouchContext, TouchStates>
- IdleState

Index

Constructors

Properties

_eventGuards _guards

Accessors

eventGuards eventReactions guards

Methods

handles touchend touchstart uponEnter uponLeave

Constructors

constructor

new IdleState(): IdleState
Returns IdleState
Inherited from TemplateState.constructor

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        TouchEventMapping,
        TouchStates,
        TouchContext,
        Guard<TouchContext, "touchPointsCount">,
    >,
> = ...

`Protected`_guards

_guards: Guard<TouchContext, "touchPointsCount"> = ...

Accessors

eventGuards

get eventGuards(): Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Returns Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Inherited from TemplateState.eventGuards
- Defined in being/interfaces.ts:115

eventReactions

get eventReactions(): Partial<
EventAction<TouchEventMapping, TouchContext, TouchStates>,
>
Returns Partial<EventAction<TouchEventMapping, TouchContext, TouchStates>>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/touch-state-machine.ts:68

guards

get guards(): Guard<Context>
Returns Guard<Context>
Inherited from TemplateState.guards
- Defined in being/interfaces.ts:111

Methods

handles

handles<K extends keyof TouchEventMapping>(
    stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>,
    event: K,
    payload: TouchEventMapping[K],
    context: TouchContext,
): TouchStates
Type Parameters
- K extends keyof TouchEventMapping
Parameters
- stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>
- event: K
- payload: TouchEventMapping[K]
- context: TouchContext
Returns TouchStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:127

touchend

touchend(
    stateMachine: TouchStateMachine,
    context: TouchContext,
    payload: TouchEventPayload,
): "IDLE" | "PENDING"
Parameters
- stateMachine: TouchStateMachine
- context: TouchContext
- payload: TouchEventPayload
Returns "IDLE" | "PENDING"
- Defined in input-state-machine/touch-state-machine.ts:77

touchstart

touchstart(
    stateMachine: TouchStateMachine,
    context: TouchContext,
    payload: TouchEventPayload,
): TouchStates
Parameters
- stateMachine: TouchStateMachine
- context: TouchContext
- payload: TouchEventPayload
Returns TouchStates
- Defined in input-state-machine/touch-state-machine.ts:72

uponEnter

uponEnter(
stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>,
context: TouchContext,
): void
Parameters
- stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>
- context: TouchContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:119

uponLeave

uponLeave(
stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>,
context: TouchContext,
): void
Parameters
- stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>
- context: TouchContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:123