Class FilePreferenceStore

PreferenceStore implementation that stores preferences in a shared file. Note: this implementation attempts to lock the preference file before reading or writing to it but it is not intended for production usage.

Hierarchy

AbstractPreferenceStore
- FilePreferenceStore

Implements

PreferenceStore

Index

Constructors

constructor

Properties

filePath

Methods

Constructors

constructor

new FilePreferenceStore(context: HandlerContext, filePath?: string): FilePreferenceStore

Overrides AbstractPreferenceStore.constructor
- Defined in lib/core/preferences/FilePreferenceStore.ts:47
Parameters
- context: HandlerContext
- Default value filePath: string = path.join(os.homedir(), ".atomist", "prefs", "client.prefs.json")
Returns FilePreferenceStore

Properties

Private Readonly filePath

filePath: string

Methods

delete

delete(key: string, options?: { scope?: PreferenceScope | string }): Promise<void>

Inherited from AbstractPreferenceStore.delete
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:84
Parameters
- key: string
- Default value options: { scope?: PreferenceScope | string } = {}
  - Optional scope?: PreferenceScope | string
Returns Promise<void>

Protected doDelete

doDelete(pref: string, namespace: string): Promise<void>

Overrides AbstractPreferenceStore.doDelete
- Defined in lib/core/preferences/FilePreferenceStore.ts:106
Parameters
- pref: string
- namespace: string
Returns Promise<void>

Protected doGet

doGet(name: string, namespace: string): Promise<Preference | undefined>

Overrides AbstractPreferenceStore.doGet
- Defined in lib/core/preferences/FilePreferenceStore.ts:55
Parameters
- name: string
- namespace: string
Returns Promise<Preference | undefined>

Protected doList

doList(namespace: string): Promise<Preference[]>

Overrides AbstractPreferenceStore.doList
- Defined in lib/core/preferences/FilePreferenceStore.ts:91
Parameters
- namespace: string
Returns Promise<Preference[]>

Protected doPut

doPut(pref: Preference): Promise<void>

Overrides AbstractPreferenceStore.doPut
- Defined in lib/core/preferences/FilePreferenceStore.ts:77
Parameters
- pref: Preference
Returns Promise<void>

Private doWithPreferenceFile

doWithPreferenceFile<V>(withPreferenceFile: WithPreferenceFile<V>): Promise<V>

- Defined in lib/core/preferences/FilePreferenceStore.ts:120
Type parameters
- V
Parameters
- withPreferenceFile: WithPreferenceFile<V>
Returns Promise<V>

get

get<V>(key: string, options?: { defaultValue?: V; scope?: PreferenceScope | string }): Promise<V | undefined>

Inherited from AbstractPreferenceStore.get
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:41
Type parameters
- V
Parameters
- key: string
- Default value options: { defaultValue?: V; scope?: PreferenceScope | string } = {}
  - Optional defaultValue?: V
  - Optional scope?: PreferenceScope | string
Returns Promise<V | undefined>

Private init

init(): void

- Defined in lib/core/preferences/FilePreferenceStore.ts:136
Returns void

list

list<V>(scope: PreferenceScope | string): Promise<Array<{ key: string; value: V }>>

Implementation of PreferenceStore.list

Inherited from AbstractPreferenceStore.list
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:68
Type parameters
- V
Parameters
- scope: PreferenceScope | string
Returns Promise<Array<{ key: string; value: V }>>

put

put<V>(key: string, value: V, options?: { scope?: PreferenceScope | string; ttl?: number }): Promise<V>

Inherited from AbstractPreferenceStore.put
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:55
Type parameters
- V
Parameters
- key: string
- value: V
- Default value options: { scope?: PreferenceScope | string; ttl?: number } = {}
  - Optional scope?: PreferenceScope | string
  - Optional ttl?: number
Returns Promise<V>

Private read

read(): Promise<PreferenceFile>

- Defined in lib/core/preferences/FilePreferenceStore.ts:116
Returns Promise<PreferenceFile>

Protected scope

scope(scope: PreferenceScope | string): string

Inherited from AbstractPreferenceStore.scope
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:103
Parameters
- scope: PreferenceScope | string
Returns string

Protected scopeKey

scopeKey(key: string, scope?: string): string

Inherited from AbstractPreferenceStore.scopeKey
- Defined in lib/core/preferences/AbstractPreferenceStore.ts:96
Parameters
- key: string
- Optional scope: string
Returns string

Generated using TypeDoc