Class StateAggregator

Hierarchy

AsyncOptionalCreatable
- StateAggregator

Index

Constructors

Properties

aliases orgs sandboxes

Methods

clearInstance clearInstanceAsync getInstance

Constructors

constructor

new StateAggregator(options?): StateAggregator
Constructs a new AsyncCreatable instance. For internal and subclass use only. New subclass instances must be created with the static create method.
Parameters
- Optional options: object
  An options object providing initialization params.
Returns StateAggregator
Inherited from AsyncOptionalCreatable.constructor
- Defined in node_modules/@salesforce/kit/lib/creatable.d.ts:33

Properties

aliases

aliases: AliasAccessor

orgs

orgs: OrgAccessor

sandboxes

sandboxes: SandboxAccessor

Methods

`Static` clearInstance

clearInstance(path?): void
Clear the cache to force reading from disk.

NOTE: Only call this method if you must and you know what you are doing. NOTE: This call is NOT thread-safe, so it should only be called when no other threads are using the StateAggregator.
Parameters
- path: string = Global.DIR
Returns void
- Defined in src/stateAggregator/stateAggregator.ts:42

`Static` clearInstanceAsync

clearInstanceAsync(path?): Promise<void>
Clear the cache to force reading from disk in a thread-safe manner.

NOTE: Only call this method if you must and you know what you are doing.
Parameters
- path: string = Global.DIR
Returns Promise<void>
- Defined in src/stateAggregator/stateAggregator.ts:51

`Static` getInstance

getInstance(): Promise<StateAggregator>
Reuse a StateAggregator if one was already created for the current global state directory Otherwise, create one and adds it to map for future reuse. HomeDir might be stubbed in tests

Returns Promise<StateAggregator>
- Defined in src/stateAggregator/stateAggregator.ts:26