Skip to content

HyperSpace API

HyperSpace

Extends Effect.

Factory Function

typescript
createHyperSpace(config?: HyperSpaceConfig): Effect<HyperSpaceConfig>

Methods

See Effect for the full method reference.


HyperSpaceConfig

typescript
interface HyperSpaceConfig {
    readonly count?: number;
    readonly speed?: number;
    readonly color?: string;
    readonly scale?: number;
}
PropertyTypeDefaultDescription
countnumber250Number of stars radiating outward.
speednumber1Outward velocity and acceleration.
colorstring'#ffffff'Color of the star streaks.
scalenumber1Uniform scale multiplier.