Interface IWidgetLSPAdapterTracker<T>

A tracker that tracks WidgetLSPAdapters.

Typeparam

T - The type of widget being tracked. Defaults to WidgetLSPAdapter.

interface IWidgetLSPAdapterTracker<
    T extends WidgetLSPAdapter = WidgetLSPAdapter,
> {
    adapterAdded: ISignal<IWidgetLSPAdapterTracker<T>, T>;
    adapterUpdated: ISignal<IWidgetLSPAdapterTracker<T>, T>;
    currentAdapter: null | T;
    currentChanged: ISignal<IWidgetLSPAdapterTracker<T>, null | T>;
    isDisposed: boolean;
    size: number;
    dispose(): void;
    filter(fn: (obj: T) => boolean): T[];
    find(fn: (obj: T) => boolean): undefined | T;
    forEach(fn: (obj: T) => void): void;
    has(obj: T): boolean;
}

Type Parameters

Hierarchy

Implemented by

Properties

adapterAdded adapterUpdated currentAdapter currentChanged isDisposed size

Methods

dispose filter find forEach has

Properties

ReadonlyadapterAdded

adapterAdded: ISignal<IWidgetLSPAdapterTracker<T>, T>

A signal emitted when an adapter is added.

ReadonlyadapterUpdated

adapterUpdated: ISignal<IWidgetLSPAdapterTracker<T>, T>

A signal emitted when a adapter is updated.

ReadonlycurrentAdapter

currentAdapter: null | T

The current adapter is the most recently focused or added adapter.

Notes

It is the most recently focused adapter, or the most recently added adapter if no adapter has taken focus.

ReadonlycurrentChanged

currentChanged: ISignal<IWidgetLSPAdapterTracker<T>, null | T>

A signal emitted when the current instance changes.

Notes

If the last instance being tracked is disposed, null will be emitted.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlysize

size: number

The number of instances held by the tracker.

Methods

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

filter

  • filter(fn: (obj: T) => boolean): T[]

  • Filter the instances in the tracker based on a predicate.

    Parameters

    • fn: (obj: T) => boolean

      The function by which to filter.

    Returns T[]

find

  • find(fn: (obj: T) => boolean): undefined | T

  • Find the first instance in the tracker that satisfies a filter function.

    Parameters

    • fn: (obj: T) => boolean

      The filter function to call on each instance.

      Notes

      If nothing is found, the value returned is undefined.

    Returns undefined | T

forEach

  • forEach(fn: (obj: T) => void): void

  • Iterate through each instance in the tracker.

    Parameters

    • fn: (obj: T) => void

      The function to call on each instance.

    Returns void

has

  • has(obj: T): boolean

  • Check if this tracker has the specified instance.

    Parameters

    • obj: T

      The object whose existence is being checked.

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods