Class AnimateRunner

Index

Constructors

Properties

_doneCallbacks _host _promise _state _tick

Methods

cancel catch complete done end finally getPromise pause progress resume setHost then _all _chain

Constructors

constructor

new AnimateRunner(host?: AnimationHost, jsAnimation?: boolean): AnimateRunner
Accepts optional host callbacks. Set jsAnimation to true to use RAF/timer ticks instead of the batched CSS animation queue.
Parameters
- host: AnimationHost = {}
- jsAnimation: boolean = false
Returns AnimateRunner

Properties

_doneCallbacks

_doneCallbacks: ((ok: boolean) => void)[]

_host

_host: AnimationHost

_promise

_promise: Promise<void> | null

_state

_state: number

_tick

_tick: (fn: VoidFunction) => void

Methods

cancel

cancel(): void
Cancels the animation.

Returns void

catch

catch(onRejected: (reason: any) => any): Promise<void>
Standard promise catcher.
Parameters
- onRejected: (reason: any) => any
Returns Promise<void>

complete

complete(status?: boolean): void
Schedule animation completion.
Parameters
- status: boolean = true
Returns void

done

done(fn: (ok: boolean) => void): void
Register a completion callback. Fires immediately if animation is already done.
Parameters
- fn: (ok: boolean) => void
Returns void

end

end(): void
Ends the animation successfully. Equivalent to user choosing to finish it immediately.

Returns void

finally

finally(onFinally: () => any): Promise<void>
Standard promise finally.
Parameters
- onFinally: () => any
Returns Promise<void>

getPromise

getPromise(): Promise<void>
Returns an internal promise that resolves on success, and rejects on cancel.

Returns Promise<void>

pause

pause(): void
Pause underlying animation (if supported).

Returns void

progress

progress(...args: any[]): void
Reports progress to host.
Parameters
- ...args: any[]
Returns void

resume

resume(): void
Resume underlying animation (if supported).

Returns void

setHost

setHost(host: AnimationHost): void
Sets or replaces the current host.
Parameters
- host: AnimationHost
Returns void

then

then<T>(
onFulfilled: (value: void) => T | PromiseLike<T>,
onRejected?: ((reason: any) => T | PromiseLike<T>) | null,
): Promise<T>
Standard "thenable" interface
Type Parameters
- T
Parameters
- onFulfilled: (value: void) => T | PromiseLike<T>
- OptionalonRejected: ((reason: any) => T | PromiseLike<T>) | null
Returns Promise<T>

`Static`_all

_all(runners: AnimateRunner[], callback: (ok: boolean) => void): void
Waits until all runners complete.
Parameters
- runners: AnimateRunner[]
- callback: (ok: boolean) => void
Returns void

`Static`_chain

_chain(runners: AnimateRunner[], callback: (ok: boolean) => void): void
Executes a list of runners sequentially. Each must complete before the next starts.
Parameters
- runners: AnimateRunner[]
- callback: (ok: boolean) => void
Returns void