Interface IObservableString

A string which can be observed for changes.

interface IObservableString {
    changed: ISignal<IObservableString, IObservableString.IChangedArgs>;
    isDisposed: boolean;
    text: string;
    type: "String";
    clear(): void;
    dispose(): void;
    insert(index: number, text: string, options?: unknown): void;
    remove(start: number, end: number, options?: unknown): void;
}

Hierarchy (View Summary)

Implemented by

Properties

changed isDisposed text type

Methods

clear dispose insert remove

Properties

Readonlychanged

changed: ISignal<IObservableString, IObservableString.IChangedArgs>

A signal emitted when the string has changed.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

text

text: string

The value of the string.

type

type: "String"

The type of the Observable.

Methods

clear

dispose

insert

  • insert(index: number, text: string, options?: unknown): void

  • Insert a substring.

    Parameters

    • index: number

      The starting index.

    • text: string

      The substring to insert.

    • Optionaloptions: unknown

    Returns void

remove

  • remove(start: number, end: number, options?: unknown): void

  • Remove a substring.

    Parameters

    • start: number

      The starting index.

    • end: number

      The ending index.

    • Optionaloptions: unknown

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods