Class ReferenceCollection<K, V>

Type Parameters

K
V extends Disposable

Hierarchy

AbstractReferenceCollection<K, V>
- ReferenceCollection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ReferenceCollection<K, V>(factory: ((key: K) => MaybePromise<V>)): ReferenceCollection<K, V>

Overrides AbstractReferenceCollection.constructor
- Defined in packages/core/src/common/reference.ts:113
Type Parameters
- K
- V extends Disposable
Parameters
- factory: ((key: K) => MaybePromise<V>)
  - - (key: K): MaybePromise<V>
    - Parameters
      - key: K
      Returns MaybePromise<V>
Returns ReferenceCollection<K, V>

Properties

Protected Readonly _keys

_keys: Map<string, K> = ...

Protected Readonly _values

_values: Map<string, V> = ...

Protected Readonly factory

factory: ((key: K) => MaybePromise<V>)

Type declaration

- (key: K): MaybePromise<V>
- Parameters
  - key: K
  Returns MaybePromise<V>

Readonly onDidCreate

onDidCreate: Event<V> = ...

Protected Readonly onDidCreateEmitter

onDidCreateEmitter: Emitter<V> = ...

Readonly onWillDispose

onWillDispose: Event<V> = ...

Protected Readonly onWillDisposeEmitter

onWillDisposeEmitter: Emitter<V> = ...

Protected Readonly pendingValues

pendingValues: Map<string, MaybePromise<V>> = ...

Protected Readonly references

references: Map<string, DisposableCollection> = ...

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Methods

acquire

acquire(args: K): Promise<Reference<V>>

Overrides AbstractReferenceCollection.acquire
- Defined in packages/core/src/common/reference.ts:117
Parameters
- args: K
Returns Promise<Reference<V>>

clear

clear(): void

Inherited from AbstractReferenceCollection.clear
- Defined in packages/core/src/common/reference.ts:49
Returns void

Protected createReferences

createReferences(key: string, value: V): DisposableCollection

Inherited from AbstractReferenceCollection.createReferences
- Defined in packages/core/src/common/reference.ts:93
Parameters
- key: string
- value: V
Returns DisposableCollection

dispose

dispose(): void

Inherited from AbstractReferenceCollection.dispose
- Defined in packages/core/src/common/reference.ts:45
Dispose this object.

Returns void

Protected doAcquire

doAcquire(key: string, object: V): Reference<V>

Inherited from AbstractReferenceCollection.doAcquire
- Defined in packages/core/src/common/reference.ts:79
Parameters
- key: string
- object: V
Returns Reference<V>

get

get(args: K): undefined | V

Inherited from AbstractReferenceCollection.get
- Defined in packages/core/src/common/reference.ts:72
Parameters
- args: K
Returns undefined | V

Protected getOrCreateValue

getOrCreateValue(key: string, args: K): Promise<V>

- Defined in packages/core/src/common/reference.ts:128
Parameters
- key: string
- args: K
Returns Promise<V>

has

has(args: K): boolean

Inherited from AbstractReferenceCollection.has
- Defined in packages/core/src/common/reference.ts:59
Parameters
- args: K
Returns boolean

keys

keys(): K[]

Inherited from AbstractReferenceCollection.keys
- Defined in packages/core/src/common/reference.ts:64
Returns K[]

Protected toKey

toKey(args: K): string

Inherited from AbstractReferenceCollection.toKey
- Defined in packages/core/src/common/reference.ts:89
Parameters
- args: K
Returns string

values

values(): V[]

Inherited from AbstractReferenceCollection.values
- Defined in packages/core/src/common/reference.ts:68
Returns V[]