Class WorkspaceCache<K, V>

Every key/value pair in this cache is scoped to the whole workspace. If any document in the workspace changes, the whole cache is evicted.

Type Parameters

K
V

Hierarchy (view full)

SimpleCache<K, V>
- WorkspaceCache

Index

Constructors

Properties

cache isDisposed toDispose

Methods

clear delete dispose get has onDispose set throwIfDisposed

Constructors

constructor

new WorkspaceCache<K, V>(sharedServices, state?): WorkspaceCache<K, V>
Creates a new workspace cache.
Type Parameters
- K
- V
Parameters
- sharedServices: LangiumSharedCoreServices
  Service container instance to hook into document lifecycle events.
- Optionalstate: DocumentState
  Optional document state on which the cache should evict. If not provided, the cache will evict on DocumentBuilder#onUpdate.
Returns WorkspaceCache<K, V>
Overrides SimpleCache.constructor
- Defined in packages/langium/src/utils/caching.ts:190

Properties

`Protected` `Readonly`cache

cache: Map<K, V> = ...

`Protected`isDisposed

isDisposed: boolean = false

`Protected`toDispose

toDispose: Disposable[] = []

Methods

clear

clear(): void
Returns void
Inherited from SimpleCache.clear
- Defined in packages/langium/src/utils/caching.ts:70

delete

delete(key): boolean
Parameters
- key: K
Returns boolean
Inherited from SimpleCache.delete
- Defined in packages/langium/src/utils/caching.ts:65

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from SimpleCache.dispose
- Defined in packages/langium/src/utils/caching.ts:21

get

get(key): undefined | V
Parameters
- key: K
Returns undefined | V
Inherited from SimpleCache.get
- Defined in packages/langium/src/utils/caching.ts:50
get(key, provider): V
Parameters
- key: K
- provider: (() => V)
  - - (): V
    - Returns V
Returns V
Inherited from SimpleCache.get
- Defined in packages/langium/src/utils/caching.ts:51

has

has(key): boolean
Parameters
- key: K
Returns boolean
Inherited from SimpleCache.has
- Defined in packages/langium/src/utils/caching.ts:40

onDispose

onDispose(disposable): void
Parameters
- disposable: Disposable
Returns void
Inherited from SimpleCache.onDispose
- Defined in packages/langium/src/utils/caching.ts:17

set

set(key, value): void
Parameters
- key: K
- value: V
Returns void
Inherited from SimpleCache.set
- Defined in packages/langium/src/utils/caching.ts:45

`Protected`throwIfDisposed

throwIfDisposed(): void
Returns void
Inherited from SimpleCache.throwIfDisposed
- Defined in packages/langium/src/utils/caching.ts:28