ConfigService | @tmtsoftware/esw-ts

A Config Service API which provides client side methods to manage configuration files residing in config server repository.

interface

Hierarchy

ConfigService

Index

Methods

create

create(path: string, configData: ConfigData, annex: boolean, comment: string): Promise<ConfigId>

- Defined in src/clients/config-service/ConfigService.ts:29
Creates a file at a specified path with given data and comment.

Parameters
- path: string
  
  the file path relative to the repository root
- configData: ConfigData
  
  contents of the file
- annex: boolean
  
  true if the file is annex and requires special handling (external storage)
- comment: string
  
  comment to associate with this operation
Returns Promise<ConfigId>
ConfigId as Promise

delete

delete(path: string, comment: string): Promise<void>

- Defined in src/clients/config-service/ConfigService.ts:92
Deletes the given config file (older versions will still be available)

Parameters
- path: string
  
  the file path relative to the repository root
- comment: string
  
  comment to associate with this operation
Returns Promise<void>

exists

exists(path: string, id?: ConfigId): Promise<boolean>

- Defined in src/clients/config-service/ConfigService.ts:84
Returns true if the given path exists and is being managed

Parameters
- path: string
  
  the file path relative to the repository root
- Optional id: ConfigId
  
  revision of the file
Returns Promise<boolean>
boolean as Promise

getActive

getActive(path: string): Promise<Option<ConfigData>>

- Defined in src/clients/config-service/ConfigService.ts:47
Gets and returns the content of active version of the file stored under the given path.

Parameters
- path: string
  
  the file path relative to the repository root
Returns Promise<Option<ConfigData>>
Option as Promise

getActiveByTime

getActiveByTime(path: string, time: Date): Promise<Option<ConfigData>>

- Defined in src/clients/config-service/ConfigService.ts:153
Returns the content of active version of the file at the given path as it existed on the given instant

Parameters
- path: string
  
  the file path relative to the repository root
- time: Date
  
  the target instant
Returns Promise<Option<ConfigData>>
Option as Promise

getActiveVersion

getActiveVersion(path: string): Promise<Option<ConfigId>>

- Defined in src/clients/config-service/ConfigService.ts:161
Returns the version which represents the "active version" of the file at the given path.

Parameters
- path: string
  
  the file path relative to the repository root
Returns Promise<Option<ConfigId>>
Option as Promise

getById

getById(path: string, configId: ConfigId): Promise<Option<ConfigData>>

- Defined in src/clients/config-service/ConfigService.ts:64
Gets and returns the file at the given path with the specified revision id.

Parameters
- path: string
  
  the file path relative to the repository root
- configId: ConfigId
  
  id used to specify a specific version to fetch
Returns Promise<Option<ConfigData>>
Option as Promise

getByTime

getByTime(path: string, time: Date): Promise<Option<ConfigData>>

- Defined in src/clients/config-service/ConfigService.ts:75
Gets the file at the given path as it existed on the given instant. If instant is before the file was created, the initial version is returned. If instant is after the last change, the most recent version is returned.

Parameters
- path: string
  
  the file path relative to the repository root
- time: Date
  
  the target instant
Returns Promise<Option<ConfigData>>
Option as Promise

getLatest

getLatest(path: string): Promise<Option<ConfigData>>

- Defined in src/clients/config-service/ConfigService.ts:55
Gets and returns the content of latest version of the file stored under the given path.

Parameters
- path: string
  
  the file path relative to the repository root
Returns Promise<Option<ConfigData>>
Option as Promise

getMetadata

getMetadata(): Promise<ConfigMetadata>

- Defined in src/clients/config-service/ConfigService.ts:168
Query the metadata of config server

Returns Promise<ConfigMetadata>
ConfigMetadata as Promise

history

history(path: string, from: Date, to: Date, maxResults: number): Promise<ConfigFileRevision[]>

- Defined in src/clients/config-service/ConfigService.ts:112
Returns the history of versions of the file at the given path for a range of period specified by from and to. The size of the list is limited upto maxResults.

Parameters
- path: string
  
  the file path relative to the repository root
- from: Date
  
  the start of the history range
- to: Date
  
  the end of the history range
- maxResults: number
  
  the maximum number of history results to return (default: unlimited)
Returns Promise<ConfigFileRevision[]>
ConfigFileRevision[] as Promise

historyActive

historyActive(path: string, from: Date, to: Date, maxResults: number): Promise<ConfigFileRevision[]>

- Defined in src/clients/config-service/ConfigService.ts:124
Returns the history of active versions of the file at the given path for a range of period specified by from and to. The size of the list is limited upto maxResults.

Parameters
- path: string
  
  the file path relative to the repository root
- from: Date
  
  the start of the history range
- to: Date
  
  the end of the history range
- maxResults: number
  
  the maximum number of history results to return (default: unlimited)
Returns Promise<ConfigFileRevision[]>
ConfigFileRevision[] as Promise

list

list(params?: { pattern?: string; type?: FileType }): Promise<ConfigFileInfo[]>

- Defined in src/clients/config-service/ConfigService.ts:100
Returns a list containing all of the known config files of given type(Annex or Normal) and whose name matches the provided pattern

Parameters
- Optional params: { pattern?: string; type?: FileType }
  
  optional file type(Annex or Normal) and optional pattern to match against the file name
  - Optional pattern?: string
  - Optional type?: FileType
Returns Promise<ConfigFileInfo[]>
ConfigFileInfo[] as Promise

resetActiveVersion

resetActiveVersion(path: string, comment: string): Promise<void>

- Defined in src/clients/config-service/ConfigService.ts:144
Resets the "active version" of the file at the given path to the latest version.

Parameters
- path: string
  
  the file path relative to the repository root
- comment: string
  
  comment to associate with this operation
Returns Promise<void>

setActiveVersion

setActiveVersion(path: string, id: ConfigId, comment: string): Promise<void>

- Defined in src/clients/config-service/ConfigService.ts:136
Sets the active version to be the version provided for the file at the given path. If this method is not called, the active version will always be the version with which the file was created After calling this method, the version with the given Id will be the active version.

Parameters
- path: string
  
  the file path relative to the repository root
- id: ConfigId
  
  an id used to specify a specific version (by default the id of the version with which the file was created i.e. 1)
- comment: string
  
  comment to associate with this operation
Returns Promise<void>

update

update(path: string, configData: ConfigData, comment: string): Promise<ConfigId>

- Defined in src/clients/config-service/ConfigService.ts:39
Updates the file content at a specified path with given data and comment.

Parameters
- path: string
  
  the file path relative to the repository root
- configData: ConfigData
  
  contents of the file
- comment: string
  
  comment to associate with this operation
Returns Promise<ConfigId>
ConfigId as Promise

Hierarchy

Index

Methods

Methods

create

Parameters

path: string

configData: ConfigData

annex: boolean

comment: string

Returns Promise<ConfigId>

delete

Parameters

path: string

comment: string

Returns Promise<void>

exists

Parameters

path: string

Optional id: ConfigId

Returns Promise<boolean>

getActive

Parameters

path: string

Returns Promise<Option<ConfigData>>

getActiveByTime

Parameters

path: string

time: Date

Returns Promise<Option<ConfigData>>

getActiveVersion

Parameters

path: string

Returns Promise<Option<ConfigId>>

getById

Parameters

path: string

configId: ConfigId

Returns Promise<Option<ConfigData>>

getByTime

Parameters

path: string

time: Date

Returns Promise<Option<ConfigData>>

getLatest

Parameters

path: string

Returns Promise<Option<ConfigData>>

getMetadata

Returns Promise<ConfigMetadata>

history

Parameters

path: string

from: Date

to: Date

maxResults: number

Returns Promise<ConfigFileRevision[]>

historyActive

Parameters

path: string

from: Date

to: Date

maxResults: number

Returns Promise<ConfigFileRevision[]>

list

Parameters

Optional params: { pattern?: string; type?: FileType }

Optional pattern?: string

Optional type?: FileType

Returns Promise<ConfigFileInfo[]>

resetActiveVersion

Parameters

path: string

comment: string

Returns Promise<void>

setActiveVersion

Parameters

path: string

id: ConfigId

comment: string