Skip to main content

SequenceManager

还没翻译译自英文(tanstack.com)本页 58 段都还没译

Defined in: sequence-manager.ts:169

Properties

registrations

readonly registrations: Store<Map<string, SequenceRegistrationView>>;

Defined in: sequence-manager.ts:176

The TanStack Store containing sequence registration views for devtools. Subscribe to this to observe registration changes.

Methods

destroy()

destroy(): void;

Defined in: sequence-manager.ts:665

Destroys the manager and removes all listeners.

Returns

void


getRegistrationCount()

getRegistrationCount(): number;

Defined in: sequence-manager.ts:658

Gets the number of registered sequences.

Returns

number


register()

register(
   sequence, 
   callback, 
   options?): SequenceRegistrationHandle;

Defined in: sequence-manager.ts:228

Registers a hotkey sequence handler.

Parameters

sequence

HotkeySequence

Array of hotkey strings that form the sequence

callback

HotkeyCallback

Function to call when the sequence is completed

options?

SequenceOptions = {}

Options for the sequence behavior

Returns

SequenceRegistrationHandle

A handle to update or unregister the sequence


resetAll()

resetAll(): void;

Defined in: sequence-manager.ts:598

Resets all sequence progress.

Returns

void


triggerSequence()

triggerSequence(id): boolean;

Defined in: sequence-manager.ts:613

Triggers a sequence's callback programmatically from devtools. Creates a synthetic KeyboardEvent from the last key in the sequence.

Parameters

id

string

The registration ID to trigger

Returns

boolean

True if the registration was found and triggered


getInstance()

static getInstance(): SequenceManager;

Defined in: sequence-manager.ts:197

Gets the singleton instance of SequenceManager.

Returns

SequenceManager


resetInstance()

static resetInstance(): void;

Defined in: sequence-manager.ts:207

Resets the singleton instance. Useful for testing.

Returns

void