pixi-wheels

TestWheelHandle

pixi-wheels


pixi-wheels / testing / TestWheelHandle

Interface: TestWheelHandle

Defined in: testing/testHarness.ts:68

Properties#

PropertyTypeDefined in
tickerFakeTickertesting/testHarness.ts:70
wheelWheeltesting/testHarness.ts:69

Methods#

advance()#

advance(ms: number, stepMs?: number): void;

Defined in: testing/testHarness.ts:72

Advance fake time.

Parameters#

ParameterType
msnumber
stepMs?number

Returns#

void


destroy()#

destroy(): void;

Defined in: testing/testHarness.ts:81

Returns#

void


runUntilIdle()#

runUntilIdle(maxMs?: number): void;

Defined in: testing/testHarness.ts:80

Advance until no ring is spinning (or maxMs fake ms pass).

Parameters#

ParameterType
maxMs?number

Returns#

void


spinAndLand()#

spinAndLand(
   target: WheelTarget, 
   landing?: LandingOptions, 
   opts?: {
  maxMs?: number;
  ring?: string;
}
): Promise<WheelSpinResult>;

Defined in: testing/testHarness.ts:78

spin(), setResult(target), then advance frames until the spin completes. Resolves with the result. Throws if it takes longer than maxMs of fake time.

Parameters#

ParameterType
targetWheelTarget
landing?LandingOptions
opts?{ maxMs?: number; ring?: string; }
opts.maxMs?number
opts.ring?string

Returns#

Promise<WheelSpinResult>