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, text, options?): void;
    remove(start, end, options?): void;
}

Hierarchy (view full)

IDisposable
IObservable
- IObservableString

Implemented by

ObservableString

Index

Properties

changed isDisposed text type

Methods

clear dispose insert remove

Properties

`Readonly` changed

changed: ISignal<IObservableString, IObservableString.IChangedArgs>

A signal emitted when the string has changed.

`Readonly` isDisposed

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

clear(): void
Set the ObservableString to an empty string.

Returns void
- Defined in packages/observables/src/observablestring.ts:48

dispose

dispose(): void
Dispose of the resources held by the string.

Returns void
Overrides IObservable.dispose
- Defined in packages/observables/src/observablestring.ts:53

insert

insert(index, text, options?): void
Insert a substring.
Parameters
- index: number
  The starting index.
- text: string
  The substring to insert.
- Optional options: unknown
Returns void
- Defined in packages/observables/src/observablestring.ts:34

remove

remove(start, end, options?): void
Remove a substring.
Parameters
- start: number
  The starting index.
- end: number
  The ending index.
- Optional options: unknown
Returns void
- Defined in packages/observables/src/observablestring.ts:43