UNPKG

@ginden/blinkstick-v2

Version:
38 lines 1.39 kB
import type { ColorInput } from '../types'; import type { Frame } from './frame/frame'; /** * @summary Bag of static methods for creating animations. * @remarks This class is a collection of static methods to create common animations. * You should use these methods to create animations easily. * @category Animation */ export declare abstract class Animation { /** * This class is not meant to be instantiated. * @private */ private constructor(); /** * @summary Shorthand for `repeat` * @param animation * @param repeatCount */ static repeat(animation: FrameIterable, repeatCount: number): FrameIterable; /** * @summary Shorthand for `repeat(pulse(color, overMs, steps), repeatCount)` */ static pulse(color: ColorInput, overMs: number, steps?: number, repeatCount?: number): FrameIterable; /** * @summary Shorthand for `morph(from, to, overMs, steps)` */ static morph(from: ColorInput, to: ColorInput, overMs: number, steps?: number): FrameIterable; /** * @summary Shorthand for `morphMany(tuples, overMs, steps)` */ static morphMany(tuples: ColorInput[], overMs: number, steps?: number): Iterable<import(".").SimpleFrame>; } /** * @category Animation */ export type FrameIterable = Iterable<Frame> | AsyncIterable<Frame>; //# sourceMappingURL=animation-description.d.ts.map