On this page

Class Transitionable<Props>

Type Parameters

Props

Index

Constructors

Methods

getTransition getValue hasProperty serialize setTransition setValue transitioned untransitioned

Constructors

constructor

new Transitionable<Props>(
properties: Properties<Props>,
globalState: Record<string, any>,
): Transitionable<Props>
Type Parameters
- Props
Parameters
- properties: Properties<Props>
- globalState: Record<string, any>
Returns Transitionable<Props>

Methods

getTransition

getTransition<S extends string | number | symbol>(
name: S,
): void | TransitionSpecification
Type Parameters
- S extends string | number | symbol
Parameters
- name: S
Returns void | TransitionSpecification

getValue

getValue<S extends string | number | symbol, T>(
name: S,
): void | PropertyValueSpecification<T>
Type Parameters
- S extends string | number | symbol
- T
Parameters
- name: S
Returns void | PropertyValueSpecification<T>

hasProperty

hasProperty(name: string): boolean
Parameters
- name: string
Returns boolean

serialize

serialize(): any
Returns any

setTransition

setTransition<S extends string | number | symbol>(
name: S,
value: void | TransitionSpecification,
): void
Type Parameters
- S extends string | number | symbol
Parameters
- name: S
- value: void | TransitionSpecification
Returns void

setValue

setValue<S extends string | number | symbol, T>(
name: S,
value: void | PropertyValueSpecification<T>,
): void
Type Parameters
- S extends string | number | symbol
- T
Parameters
- name: S
- value: void | PropertyValueSpecification<T>
Returns void

transitioned

transitioned(
parameters: TransitionParameters,
prior: Transitioning<Props>,
): Transitioning<Props>
Parameters
- parameters: TransitionParameters
- prior: Transitioning<Props>
Returns Transitioning<Props>

untransitioned

untransitioned(): Transitioning<Props>
Returns Transitioning<Props>

Was this helpful?