Class ScratchOrgCache

A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.

Example

import { Duration } from '@salesforce/kit';
const config = await TTLConfig.create({
  isGlobal: false,
  ttl: Duration.days(1)
});

Hierarchy (view full)

TTLConfig<TTLConfig.Options, CachedOptions>
- ScratchOrgCache

Methods

access

access(perm?): Promise<boolean>
Determines if the config file is read/write accessible. Returns true if the user has capabilities specified by perm.
Parameters
- Optional perm: number
  The permission.
  
  See https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_access_path_mode_callback
Returns Promise<boolean>
Inherited from TTLConfig.access
- Defined in src/config/configFile.ts:125

accessSync

accessSync(perm?): boolean
Determines if the config file is read/write accessible. Returns true if the user has capabilities specified by perm.
Parameters
- Optional perm: number
  The permission.
  
  See https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_access_path_mode_callback
Returns boolean
Inherited from TTLConfig.accessSync
- Defined in src/config/configFile.ts:142

clear

clear(): void
Removes all key/value pairs from the config object.

Returns void
Inherited from TTLConfig.clear
- Defined in src/config/configStore.ts:207

entries

entries(): ConfigEntry[]
Returns an array of ConfigEntry for each element in the config.

Returns ConfigEntry[]
Inherited from TTLConfig.entries
- Defined in src/config/configStore.ts:82

exists

exists(): Promise<boolean>
Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

Returns Promise<boolean>
Inherited from TTLConfig.exists
- Defined in src/config/configFile.ts:280

existsSync

existsSync(): boolean
Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

Returns boolean
Inherited from TTLConfig.existsSync
- Defined in src/config/configFile.ts:287

forEach

forEach(actionFn): void
Invokes actionFn once for each key-value pair present in the config object.
Parameters
- actionFn: ((key, value) => void)
  The function (key: string, value: ConfigValue) => void to be called for each element.
  - - (key, value): void
    - Parameters
      key: string
      value: AnyJson
      Returns void
Returns void
Inherited from TTLConfig.forEach
- Defined in src/config/configStore.ts:240

get

get<K>(key, decrypt?): Entry<CachedOptions>
Returns the value associated to the key, or undefined if there is none.
Type Parameters
- K extends string
Parameters
- key: K
  The key (object property)
- Optional decrypt: boolean
  If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.
Returns Entry<CachedOptions>
Inherited from TTLConfig.get
- Defined in src/config/configStore.ts:94
get<V>(key, decrypt?): V
Type Parameters
- V = AnyJson
Parameters
- key: string
- Optional decrypt: boolean
Returns V
Inherited from TTLConfig.get
- Defined in src/config/configStore.ts:97

getContents

getContents(decrypt?): Readonly<Contents<CachedOptions>>
Returns the entire config contents.

NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.
Parameters
- decrypt: boolean = false
Returns Readonly<Contents<CachedOptions>>
Inherited from TTLConfig.getContents
- Defined in src/config/configStore.ts:228

getKeysByValue

getKeysByValue(value): string[]
Returns the list of keys that contain a value.
Parameters
- value: AnyJson
  The value to filter keys on.
Returns string[]
Inherited from TTLConfig.getKeysByValue
- Defined in src/config/configStore.ts:118

getLatestEntry

getLatestEntry(): Nullable<[string, Entry<CachedOptions>]>
Returns Nullable<[string, Entry<CachedOptions>]>
Inherited from TTLConfig.getLatestEntry
- Defined in src/config/ttlConfig.ts:29

getLatestKey

getLatestKey(): Nullable<string>
Returns Nullable<string>
Inherited from TTLConfig.getLatestKey
- Defined in src/config/ttlConfig.ts:37

getPath

getPath(): string
Returns the absolute path to the config file.

The first time getPath is called, the path is resolved and becomes immutable. This allows implementers to override options properties, like filePath, on the init method for async creation. If that is required for creation, the config files can not be synchronously created.

Returns string
Inherited from TTLConfig.getPath
- Defined in src/config/configFile.ts:344

has

has(key): boolean
Returns a boolean asserting whether a value has been associated to the key in the config object or not.
Parameters
- key: string
Returns boolean
Inherited from TTLConfig.has
- Defined in src/config/configStore.ts:128

isExpired

isExpired(dateTime, value): boolean
Parameters
- dateTime: number
- value: CachedOptions & {
  timestamp: string;
  }
Returns boolean
Inherited from TTLConfig.isExpired
- Defined in src/config/ttlConfig.ts:42

isGlobal

isGlobal(): boolean
Returns true if this config is using the global path, false otherwise.

Returns boolean
Inherited from TTLConfig.isGlobal
- Defined in src/config/configFile.ts:367

keys

keys(): string[]
Returns an array that contains the keys for each element in the config object.

Returns string[]
Inherited from TTLConfig.keys
- Defined in src/config/configStore.ts:135

read

read(throwOnNotFound?, force?): Promise<Contents<CachedOptions>>
Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.
Parameters
- Optional throwOnNotFound: boolean = false
  Optionally indicate if a throw should occur on file read.
- Optional force: boolean = false
  Optionally force the file to be read from disk even when already read within the process.
Returns Promise<Contents<CachedOptions>>
Inherited from TTLConfig.read
- Defined in src/config/configFile.ts:160

readSync

readSync(throwOnNotFound?, force?): Contents<CachedOptions>
Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.
Parameters
- Optional throwOnNotFound: boolean = false
  Optionally indicate if a throw should occur on file read.
- Optional force: boolean = false
  Optionally force the file to be read from disk even when already read within the process.
Returns Contents<CachedOptions>
Inherited from TTLConfig.readSync
- Defined in src/config/configFile.ts:201

set

set(key, value): void
Sets the value for the key in the config object. This will override the existing value. To do a partial update, use BaseConfigStore.update.
Parameters
- key: string
  The key.
- value: Partial<Entry<CachedOptions>>
  The value.
Returns void
Inherited from TTLConfig.set
- Defined in src/config/ttlConfig.ts:25

setContentsFromObject

setContentsFromObject(obj): void
Convert an object to a ConfigContents and set it as the config contents.
Parameters
- obj: Contents<CachedOptions>
  The object.
Returns void
Inherited from TTLConfig.setContentsFromObject
- Defined in src/config/configStore.ts:257

stat

stat(): Promise<Stats>
Get the stats of the file. Returns the stats of the file.

fs.stat

Returns Promise<Stats>
Inherited from TTLConfig.stat
- Defined in src/config/configFile.ts:296

statSync

statSync(): Stats
Get the stats of the file. Returns the stats of the file.

fs.stat

Returns Stats
Inherited from TTLConfig.statSync
- Defined in src/config/configFile.ts:305

toObject

toObject(): JsonMap
Convert the config object to a JSON object. Returns the config contents. Same as calling ConfigStore.getContents

Returns JsonMap
Inherited from TTLConfig.toObject
- Defined in src/config/configStore.ts:248

unlink

unlink(): Promise<void>
Delete the config file if it exists.

Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

Returns Promise<void>
Inherited from TTLConfig.unlink
- Defined in src/config/configFile.ts:315

unlinkSync

unlinkSync(): void
Delete the config file if it exists.

Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

Returns void
Inherited from TTLConfig.unlinkSync
- Defined in src/config/configFile.ts:329

unset

unset<K>(key): boolean
Returns true if an element in the config object existed and has been removed, or false if the element does not exist. BaseConfigStore.has will return false afterwards.
Type Parameters
- K extends string
Parameters
- key: K
  The key
Returns boolean
Inherited from TTLConfig.unset
- Defined in src/config/configStore.ts:186

unsetAll

unsetAll(keys): boolean
Returns true if all elements in the config object existed and have been removed, or false if all the elements do not exist (some may have been removed). BaseConfigStore.has(key) will return false afterwards.
Parameters
- keys: string[]
  The keys
Returns boolean
Inherited from TTLConfig.unsetAll
- Defined in src/config/configStore.ts:200

update

update<K>(key, value): void
Updates the value for the key in the config object. If the value is an object, it will be merged with the existing object.
Type Parameters
- K extends string
Parameters
- key: K
  The key.
- value: Partial<Entry<CachedOptions>>
  The value.
Returns void
Inherited from TTLConfig.update
- Defined in src/config/configStore.ts:170

values

values(): AnyJson[]
Returns an array that contains the values for each element in the config object.

Returns AnyJson[]
Inherited from TTLConfig.values
- Defined in src/config/configStore.ts:214

write

write(): Promise<Contents<CachedOptions>>
Write the config file with new contents. If no new contents are provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

Returns Promise<Contents<CachedOptions>>
Inherited from TTLConfig.write
- Defined in src/config/configFile.ts:237

writeSync

writeSync(): Contents<CachedOptions>
Write the config file with new contents. If no new contents are provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

Returns Contents<CachedOptions>
Inherited from TTLConfig.writeSync
- Defined in src/config/configFile.ts:260

`Static` getDefaultOptions

getDefaultOptions(): TTLConfig.Options
Returns the default options for the config file.

Returns TTLConfig.Options
Overrides TTLConfig.getDefaultOptions
- Defined in src/org/scratchOrgCache.ts:32

`Static` getFileName

getFileName(): string
Returns the config's filename.

Returns string
Overrides TTLConfig.getFileName
- Defined in src/org/scratchOrgCache.ts:28

`Static` resolveRootFolder

resolveRootFolder(isGlobal): Promise<string>
Helper used to determine what the local and global folder point to. Returns the file path of the root folder.
Parameters
- isGlobal: boolean
  True if the config should be global. False for local.
Returns Promise<string>
Inherited from TTLConfig.resolveRootFolder
- Defined in src/config/configFile.ts:104

`Static` resolveRootFolderSync

resolveRootFolderSync(isGlobal): string
Helper used to determine what the local and global folder point to. Returns the file path of the root folder.
Parameters
- isGlobal: boolean
  True if the config should be global. False for local.
Returns string
Inherited from TTLConfig.resolveRootFolderSync
- Defined in src/config/configFile.ts:113

`Static` unset

unset(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in src/org/scratchOrgCache.ts:43

Class ScratchOrgCache

Example

Hierarchy (view full)

Index

Methods

Methods

access

Parameters

Returns Promise<boolean>

accessSync

Parameters

Returns boolean

clear

Returns void

entries

Returns ConfigEntry[]

exists

Returns Promise<boolean>

existsSync

Returns boolean

forEach

Parameters

Parameters

Returns void

Returns void

get

Type Parameters

Parameters

Returns Entry<CachedOptions>

Type Parameters

Parameters

Returns V

getContents

Parameters

Returns Readonly<Contents<CachedOptions>>

getKeysByValue

Parameters

Returns string[]

getLatestEntry

Returns Nullable<[string, Entry<CachedOptions>]>

getLatestKey

Returns Nullable<string>

getPath

Returns string

has

Parameters

Returns boolean

isExpired

Parameters

Returns boolean

isGlobal

Returns boolean

keys

Returns string[]

read

Parameters

Returns Promise<Contents<CachedOptions>>

readSync

Parameters

Returns Contents<CachedOptions>

set

Parameters

Returns void

setContentsFromObject

Parameters

Returns void

stat

Returns Promise<Stats>

statSync

Returns Stats

toObject

Returns JsonMap

unlink

Returns Promise<void>

unlinkSync

Returns void

unset

Type Parameters

Parameters

Returns boolean

`Static` getDefaultOptions

`Static` getFileName

`Static` resolveRootFolder

`Static` resolveRootFolderSync

`Static` unset