Skip to content

eo-typewriterjs


eo-typewriterjs / TSelectCommand

Type Alias: TSelectCommand

ts
type TSelectCommand = TBaseCommand & object;

Defined in: core/commands/types/select-command.type.ts:34

Type Declaration

NameTypeDefined in
kindtypeof SELECTcore/commands/types/select-command.type.ts:35
cursorTCursorSelectorcore/commands/types/select-command.type.ts:36
countTSelectValuecore/commands/types/select-command.type.ts:37
by?TAdvanceModeInputcore/commands/types/select-command.type.ts:38
interval?numbercore/commands/types/select-command.type.ts:39

Description

A command that selects a range of text relative to the cursor's current position, or selects an absolute document boundary range.

Operand semantics:

  • number: relative selection; positive = forward, negative = backward
  • "start": select from cursor to document start
  • "end": select from cursor to document end
  • "whole": select the entire document

Selection is computed at reduce time using the runtime document state. Any subsequent type, delete, or move command clears the selection.

When interval is provided the timeline clock advances by that many milliseconds after the event is emitted. Omit interval to use the default of 50 ms.

Released under the MIT License.