​
Classes

​
AWSParameterStoreConfigStore

A storage engine interface for Configs records. https://configu.com/docs/config-store/

​
Extends

​
Constructors

new AWSParameterStoreConfigStore()

new AWSParameterStoreConfigStore(configuration): AWSParameterStoreConfigStore

Parameters

• configuration: SSMClientConfig

Returns

AWSParameterStoreConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/AWSParameterStore.ts:15

​
Methods

delete()

delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/AWSParameterStore.ts:34

getByKey()

getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/AWSParameterStore.ts:21

upsert()

upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/AWSParameterStore.ts:28

​
AWSSecretsManagerConfigStore

A storage engine interface for Configs records. https://configu.com/docs/config-store/

​
Extends

​
Constructors

new AWSSecretsManagerConfigStore()

new AWSSecretsManagerConfigStore(configuration): AWSSecretsManagerConfigStore

Parameters

• configuration: SecretsManagerClientConfig

Returns

AWSSecretsManagerConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/AWSSecretsManager.ts:15

​
Methods

delete()

delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/AWSSecretsManager.ts:40

getByKey()

getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/AWSSecretsManager.ts:21

upsert()

upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/AWSSecretsManager.ts:27

​
AzureKeyVaultConfigStore

A storage engine interface for Configs records. https://configu.com/docs/config-store/

​
Extends

​
Constructors

new AzureKeyVaultConfigStore()

new AzureKeyVaultConfigStore(__namedParameters): AzureKeyVaultConfigStore

Parameters

• __namedParameters: AzureKeyVaultConfigStoreConfiguration

Returns

AzureKeyVaultConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/AzureKeyVault.ts:13

​
Methods

delete()

delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/AzureKeyVault.ts:32

getByKey()

getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/AzureKeyVault.ts:20

upsert()

upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/AzureKeyVault.ts:27

​
CloudBeesConfigStore

​
Extends

  • OpenFeatureConfigStore

​
Constructors

new CloudBeesConfigStore()

new CloudBeesConfigStore(configuration): CloudBeesConfigStore

Parameters

• configuration: CloudBeesConfigStoreConfiguration

Returns

CloudBeesConfigStore

Overrides

OpenFeatureConfigStore.constructor

Source

node/src/stores/CloudBees.ts:13

​
Properties

provider

protected readonly provider: Provider | Promise<Provider>

Inherited from

OpenFeatureConfigStore.provider

Source

node/src/stores/OpenFeature.ts:16

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

OpenFeatureConfigStore.get

Source

node/src/stores/OpenFeature.ts:55

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

OpenFeatureConfigStore.init

Source

node/src/stores/OpenFeature.ts:26

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

OpenFeatureConfigStore.set

Source

node/src/stores/OpenFeature.ts:64

​
CockroachDBConfigStore

​
Extends

  • ORMConfigStore

​
Constructors

new CockroachDBConfigStore()

new CockroachDBConfigStore(configuration): CockroachDBConfigStore

Parameters

• configuration: Omit<CockroachConnectionOptions, "type">

Returns

CockroachDBConfigStore

Overrides

ORMConfigStore.constructor

Source

node/src/stores/CockroachDB.ts:8

​
Properties

dataSource

readonly dataSource: DataSource

Inherited from

ORMConfigStore.dataSource

Source

node/src/stores/ORM.ts:34

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

ORMConfigStore.get

Source

node/src/stores/ORM.ts:69

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ORMConfigStore.init

Source

node/src/stores/ORM.ts:48

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

ORMConfigStore.set

Source

node/src/stores/ORM.ts:80

​
CsvFileConfigStore

​
Extends

  • FileConfigStore

​
Constructors

new CsvFileConfigStore()

new CsvFileConfigStore(__namedParameters): CsvFileConfigStore

Parameters

• __namedParameters: CsvFileConfigStoreConfiguration

Returns

CsvFileConfigStore

Overrides

FileConfigStore.constructor

Source

node/src/stores/CsvFile.ts:8

​
Properties

initialFileState

readonly initialFileState: string

Inherited from

FileConfigStore.initialFileState

Source

node/src/stores/File.ts:9

path

readonly path: string

Inherited from

FileConfigStore.path

Source

node/src/stores/File.ts:8

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

FileConfigStore.get

Source

node/src/stores/File.ts:40

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

FileConfigStore.init

Source

node/src/stores/File.ts:16

parse()

parse(fileContent): Config[]

Parameters

• fileContent: string

Returns

Config[]

Overrides

FileConfigStore.parse

Source

node/src/stores/CsvFile.ts:13

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

FileConfigStore.set

Source

node/src/stores/File.ts:51

stringify()

stringify(nextConfigs): string

Parameters

• nextConfigs: Config[]

Returns

string

Overrides

FileConfigStore.stringify

Source

node/src/stores/CsvFile.ts:17

​
EtcdConfigStore

EtcdConfigStore is a KeyValueConfigStore implementation that uses etcd3 as a backend.

​
Description

etcd3 is a Node.js client for etcd, a distributed key-value store.

​
See

https://www.npmjs.com/package/etcd3

​
Example

import { EtcdConfigStore } from './EtcdConfigStore';
const configStore = new EtcdConfigStore({ hosts: '127.0.0.1:2379' });

​
Extends

​
Constructors

new EtcdConfigStore()

new EtcdConfigStore(config): EtcdConfigStore

Parameters

• config: IOptions

Returns

EtcdConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/Etcd.ts:20

​
Properties

client

client: Etcd3

Source

node/src/stores/Etcd.ts:18

​
Methods

delete()

protected delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/Etcd.ts:34

getByKey()

protected getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/Etcd.ts:25

upsert()

protected upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/Etcd.ts:30

​
ExportCommand

​
Extends

​
Constructors

new ExportCommand()

new ExportCommand(parameters): ExportCommand

Parameters

• parameters: ExportCommandParameters

Returns

ExportCommand

Overrides

ExportCommand.constructor

Source

node/src/commands/ExportCommand.ts:15

​
Properties

parameters

parameters: ExportCommandParameters

Inherited from

ExportCommand.parameters

Source

node/src/commands/ExportCommand.ts:15

​
Methods

run()

run(): Promise<object>

Returns

Promise<object>

Overrides

ExportCommand.run

Source

node/src/commands/ExportCommand.ts:19

​
GCPSecretManagerConfigStore

A storage engine interface for Configs records. https://configu.com/docs/config-store/

​
Extends

​
Constructors

new GCPSecretManagerConfigStore()

new GCPSecretManagerConfigStore(__namedParameters): GCPSecretManagerConfigStore

Parameters

• __namedParameters: ClientOptions & object

Returns

GCPSecretManagerConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/GCPSecretManager.ts:12

​
Methods

delete()

delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/GCPSecretManager.ts:62

getByKey()

getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/GCPSecretManager.ts:24

upsert()

upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/GCPSecretManager.ts:43

​
HashiCorpVaultConfigStore

A storage engine interface for Configs records. https://configu.com/docs/config-store/

​
Extends

​
Constructors

new HashiCorpVaultConfigStore()

new HashiCorpVaultConfigStore(configuration): HashiCorpVaultConfigStore

Parameters

• configuration: HashiCorpVaultConfigStoreConfiguration

Returns

HashiCorpVaultConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/HashiCorpVault.ts:10

​
Methods

delete()

delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/HashiCorpVault.ts:41

getByKey()

getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/HashiCorpVault.ts:31

upsert()

upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/HashiCorpVault.ts:37

​
IniFileConfigStore

​
Extends

  • FileConfigStore

​
Constructors

new IniFileConfigStore()

new IniFileConfigStore(__namedParameters): IniFileConfigStore

Parameters

• __namedParameters: IniFileConfigStoreConfiguration

Returns

IniFileConfigStore

Overrides

FileConfigStore.constructor

Source

node/src/stores/IniFile.ts:9

​
Properties

initialFileState

readonly initialFileState: string

Inherited from

FileConfigStore.initialFileState

Source

node/src/stores/File.ts:9

path

readonly path: string

Inherited from

FileConfigStore.path

Source

node/src/stores/File.ts:8

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

FileConfigStore.get

Source

node/src/stores/File.ts:40

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

FileConfigStore.init

Source

node/src/stores/File.ts:16

parse()

parse(fileContent): object[]

Parameters

• fileContent: string

Returns

object[]

Overrides

FileConfigStore.parse

Source

node/src/stores/IniFile.ts:14

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

FileConfigStore.set

Source

node/src/stores/File.ts:51

stringify()

stringify(nextConfigs): string

Parameters

• nextConfigs: Config[]

Returns

string

Overrides

FileConfigStore.stringify

Source

node/src/stores/IniFile.ts:35

​
JsonFileConfigStore

​
Extends

  • FileConfigStore

​
Constructors

new JsonFileConfigStore()

new JsonFileConfigStore(__namedParameters): JsonFileConfigStore

Parameters

• __namedParameters: JsonFileConfigStoreConfiguration

Returns

JsonFileConfigStore

Overrides

FileConfigStore.constructor

Source

node/src/stores/JsonFile.ts:7

​
Properties

initialFileState

readonly initialFileState: string

Inherited from

FileConfigStore.initialFileState

Source

node/src/stores/File.ts:9

path

readonly path: string

Inherited from

FileConfigStore.path

Source

node/src/stores/File.ts:8

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

FileConfigStore.get

Source

node/src/stores/File.ts:40

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

FileConfigStore.init

Source

node/src/stores/File.ts:16

parse()

parse(fileContent): ConfigStoreContents[]

Parameters

• fileContent: string

Returns

ConfigStoreContents[]

Overrides

FileConfigStore.parse

Source

node/src/stores/JsonFile.ts:12

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

FileConfigStore.set

Source

node/src/stores/File.ts:51

stringify()

stringify(nextConfigs): string

Parameters

• nextConfigs: Config[]

Returns

string

Overrides

FileConfigStore.stringify

Source

node/src/stores/JsonFile.ts:16

​
KeyvConfigStore

KeyvConfigStore is a KeyValueConfigStore implementation that uses Keyv as a backend.

​
Description

Keyv is a simple key-value store for Node.js with support for multiple backends.

​
See

https://www.npmjs.com/package/keyv

​
Example

import Keyv from 'keyv';
import { KeyvConfigStore } from '@configu/ts-node';
const keyvMongo = new Keyv('mongodb://user:pass@localhost:27017/dbname');
const configStore = new KeyvConfigStore({ keyvInstance: keyvMongo });

​
Extends

​
Constructors

new KeyvConfigStore()

new KeyvConfigStore(__namedParameters): KeyvConfigStore

Parameters

• __namedParameters: KeyvConfigStoreConfiguration

Returns

KeyvConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/Keyv.ts:24

​
Properties

client

client: Keyv<any, Record<string, unknown>>

Source

node/src/stores/Keyv.ts:22

​
Methods

delete()

protected delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/Keyv.ts:38

getByKey()

protected getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/Keyv.ts:29

upsert()

protected upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/Keyv.ts:34

​
KubernetesSecretConfigStore

A storage engine interface for Configs records. https://configu.com/docs/config-store/

​
Extends

​
Constructors

new KubernetesSecretConfigStore()

new KubernetesSecretConfigStore(__namedParameters): KubernetesSecretConfigStore

Parameters

• __namedParameters: KubernetesSecretConfigStoreConfiguration

Returns

KubernetesSecretConfigStore

Overrides

KeyValueConfigStore.constructor

Source

node/src/stores/KubernetesSecret.ts:14

​
Methods

delete()

delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.delete

Source

node/src/stores/KubernetesSecret.ts:65

getByKey()

getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Overrides

KeyValueConfigStore.getByKey

Source

node/src/stores/KubernetesSecret.ts:27

upsert()

upsert(key, value): Promise<void>

Parameters

• key: string

• value: string

Returns

Promise<void>

Overrides

KeyValueConfigStore.upsert

Source

node/src/stores/KubernetesSecret.ts:34

​
LaunchDarklyConfigStore

​
Extends

  • OpenFeatureConfigStore

​
Constructors

new LaunchDarklyConfigStore()

new LaunchDarklyConfigStore(configurations): LaunchDarklyConfigStore

Parameters

• configurations: LaunchDarklyConfigStoreConfiguration

Returns

LaunchDarklyConfigStore

Overrides

OpenFeatureConfigStore.constructor

Source

node/src/stores/LaunchDarkly.ts:15

​
Properties

provider

protected readonly provider: Provider | Promise<Provider>

Inherited from

OpenFeatureConfigStore.provider

Source

node/src/stores/OpenFeature.ts:16

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Overrides

OpenFeatureConfigStore.get

Source

node/src/stores/LaunchDarkly.ts:29

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

OpenFeatureConfigStore.init

Source

node/src/stores/OpenFeature.ts:26

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

OpenFeatureConfigStore.set

Source

node/src/stores/OpenFeature.ts:64

​
MSSQLConfigStore

​
Extends

  • ORMConfigStore

​
Constructors

new MSSQLConfigStore()

new MSSQLConfigStore(configuration): MSSQLConfigStore

Parameters

• configuration: Omit<SqlServerConnectionOptions, "type">

Returns

MSSQLConfigStore

Overrides

ORMConfigStore.constructor

Source

node/src/stores/MSSQL.ts:8

​
Properties

dataSource

readonly dataSource: DataSource

Inherited from

ORMConfigStore.dataSource

Source

node/src/stores/ORM.ts:34

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

ORMConfigStore.get

Source

node/src/stores/ORM.ts:69

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ORMConfigStore.init

Source

node/src/stores/ORM.ts:48

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

ORMConfigStore.set

Source

node/src/stores/ORM.ts:80

​
MariaDBConfigStore

​
Extends

  • ORMConfigStore

​
Constructors

new MariaDBConfigStore()

new MariaDBConfigStore(configuration): MariaDBConfigStore

Parameters

• configuration: Omit<MysqlConnectionOptions, "type">

Returns

MariaDBConfigStore

Overrides

ORMConfigStore.constructor

Source

node/src/stores/MariaDB.ts:8

​
Properties

dataSource

readonly dataSource: DataSource

Inherited from

ORMConfigStore.dataSource

Source

node/src/stores/ORM.ts:34

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

ORMConfigStore.get

Source

node/src/stores/ORM.ts:69

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ORMConfigStore.init

Source

node/src/stores/ORM.ts:48

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

ORMConfigStore.set

Source

node/src/stores/ORM.ts:80

​
MySQLConfigStore

​
Extends

  • ORMConfigStore

​
Constructors

new MySQLConfigStore()

new MySQLConfigStore(configuration): MySQLConfigStore

Parameters

• configuration: Omit<MysqlConnectionOptions, "type">

Returns

MySQLConfigStore

Overrides

ORMConfigStore.constructor

Source

node/src/stores/MySQL.ts:7

​
Properties

dataSource

readonly dataSource: DataSource

Inherited from

ORMConfigStore.dataSource

Source

node/src/stores/ORM.ts:34

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

ORMConfigStore.get

Source

node/src/stores/ORM.ts:69

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ORMConfigStore.init

Source

node/src/stores/ORM.ts:48

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

ORMConfigStore.set

Source

node/src/stores/ORM.ts:80

​
PostgreSQLConfigStore

​
Extends

  • ORMConfigStore

​
Constructors

new PostgreSQLConfigStore()

new PostgreSQLConfigStore(configuration): PostgreSQLConfigStore

Parameters

• configuration: Omit<PostgresConnectionOptions, "type">

Returns

PostgreSQLConfigStore

Overrides

ORMConfigStore.constructor

Source

node/src/stores/PostgreSQL.ts:8

​
Properties

dataSource

readonly dataSource: DataSource

Inherited from

ORMConfigStore.dataSource

Source

node/src/stores/ORM.ts:34

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

ORMConfigStore.get

Source

node/src/stores/ORM.ts:69

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ORMConfigStore.init

Source

node/src/stores/ORM.ts:48

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

ORMConfigStore.set

Source

node/src/stores/ORM.ts:80

​
SQLiteConfigStore

​
Extends

  • ORMConfigStore

​
Constructors

new SQLiteConfigStore()

new SQLiteConfigStore(configuration): SQLiteConfigStore

Parameters

• configuration: SQLiteConfigStoreConfiguration

Returns

SQLiteConfigStore

Overrides

ORMConfigStore.constructor

Source

node/src/stores/SQLite.ts:7

​
Properties

dataSource

readonly dataSource: DataSource

Inherited from

ORMConfigStore.dataSource

Source

node/src/stores/ORM.ts:34

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

ORMConfigStore.get

Source

node/src/stores/ORM.ts:69

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ORMConfigStore.init

Source

node/src/stores/ORM.ts:48

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

ORMConfigStore.set

Source

node/src/stores/ORM.ts:80

​
TomlFileConfigStore

​
Extends

  • FileConfigStore

​
Constructors

new TomlFileConfigStore()

new TomlFileConfigStore(__namedParameters): TomlFileConfigStore

Parameters

• __namedParameters: TomlFileConfigStoreConfiguration

Returns

TomlFileConfigStore

Overrides

FileConfigStore.constructor

Source

node/src/stores/TomlFile.ts:9

​
Properties

initialFileState

readonly initialFileState: string

Inherited from

FileConfigStore.initialFileState

Source

node/src/stores/File.ts:9

path

readonly path: string

Inherited from

FileConfigStore.path

Source

node/src/stores/File.ts:8

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

FileConfigStore.get

Source

node/src/stores/File.ts:40

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

FileConfigStore.init

Source

node/src/stores/File.ts:16

parse()

parse(fileContent): object[]

Parameters

• fileContent: string

Returns

object[]

Overrides

FileConfigStore.parse

Source

node/src/stores/TomlFile.ts:14

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

FileConfigStore.set

Source

node/src/stores/File.ts:51

stringify()

stringify(nextConfigs): string

Parameters

• nextConfigs: Config[]

Returns

string

Overrides

FileConfigStore.stringify

Source

node/src/stores/TomlFile.ts:35

​
XmlFileConfigStore

​
Extends

  • FileConfigStore

​
Constructors

new XmlFileConfigStore()

new XmlFileConfigStore(__namedParameters): XmlFileConfigStore

Parameters

• __namedParameters: XmlFileConfigStoreConfiguration

Returns

XmlFileConfigStore

Overrides

FileConfigStore.constructor

Source

node/src/stores/XmlFile.ts:9

​
Properties

initialFileState

readonly initialFileState: string

Inherited from

FileConfigStore.initialFileState

Source

node/src/stores/File.ts:9

path

readonly path: string

Inherited from

FileConfigStore.path

Source

node/src/stores/File.ts:8

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Inherited from

FileConfigStore.get

Source

node/src/stores/File.ts:40

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

FileConfigStore.init

Source

node/src/stores/File.ts:16

parse()

parse(fileContent): Config[]

Parameters

• fileContent: string

Returns

Config[]

Overrides

FileConfigStore.parse

Source

node/src/stores/XmlFile.ts:16

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Inherited from

FileConfigStore.set

Source

node/src/stores/File.ts:51

stringify()

stringify(nextConfigs): string

Parameters

• nextConfigs: Config[]

Returns

string

Overrides

FileConfigStore.stringify

Source

node/src/stores/XmlFile.ts:29

​
Type Aliases

​
AWSParameterStoreConfigStoreConfiguration

AWSParameterStoreConfigStoreConfiguration: SSMClientConfig

​
Source

node/src/stores/AWSParameterStore.ts:11

​
AWSSecretsManagerConfigStoreConfiguration

AWSSecretsManagerConfigStoreConfiguration: SecretsManagerClientConfig

​
Source

node/src/stores/AWSSecretsManager.ts:11

​
AzureKeyVaultConfigStoreConfiguration

AzureKeyVaultConfigStoreConfiguration: object

​
Type declaration

credential

credential: DefaultAzureCredentialClientIdOptions

options?

optional options: SecretClientOptions

vaultUrl

vaultUrl: string

​
Source

node/src/stores/AzureKeyVault.ts:5

​
CloudBeesConfigStoreConfiguration

CloudBeesConfigStoreConfiguration: object

​
Type declaration

appKey

appKey: string

context?

optional context: EvaluationContext

providerOptions?

optional providerOptions: RoxSetupOptions

​
Source

node/src/stores/CloudBees.ts:6

​
CockroachDBConfigStoreConfiguration

CockroachDBConfigStoreConfiguration: Omit<CockroachConnectionOptions, "type"> & ORMConfigStoreSharedConfiguration

​
Source

node/src/stores/CockroachDB.ts:4

​
CsvFileConfigStoreConfiguration

CsvFileConfigStoreConfiguration: object

​
Type declaration

path

path: string

​
Source

node/src/stores/CsvFile.ts:5

​
EtcdConfigStoreConfiguration

EtcdConfigStoreConfiguration: IOptions

​
Source

node/src/stores/Etcd.ts:4

​
GCPSecretManagerConfigStoreConfiguration

GCPSecretManagerConfigStoreConfiguration: ConstructorParameters<typeof SecretManagerServiceClient>["0"] & object

​
Type declaration

projectId

projectId: string

​
Source

node/src/stores/GCPSecretManager.ts:4

​
HashiCorpVaultConfigStoreConfiguration

HashiCorpVaultConfigStoreConfiguration: object

​
Type declaration

address?

optional address: string

engine

engine: string

token?

optional token: string

​
Source

node/src/stores/HashiCorpVault.ts:4

​
IniFileConfigStoreConfiguration

IniFileConfigStoreConfiguration: object

​
Type declaration

path

path: string

​
Source

node/src/stores/IniFile.ts:6

​
JsonFileConfigStoreConfiguration

JsonFileConfigStoreConfiguration: object

​
Type declaration

path

path: string

​
Source

node/src/stores/JsonFile.ts:4

​
KeyvConfigStoreConfiguration

KeyvConfigStoreConfiguration: object

​
Type declaration

keyvInstance

keyvInstance: Keyv

​
Source

node/src/stores/Keyv.ts:6

​
KubernetesSecretConfigStoreConfiguration

KubernetesSecretConfigStoreConfiguration: object

​
Type declaration

kubeconfig?

optional kubeconfig: string

namespace

namespace: string

​
Source

node/src/stores/KubernetesSecret.ts:6

​
LaunchDarklyConfigStoreConfiguration

LaunchDarklyConfigStoreConfiguration: object

​
Type declaration

context

context: EvaluationContext

ldOptions?

optional ldOptions: LDOptions

sdkKey

sdkKey: string

​
Source

node/src/stores/LaunchDarkly.ts:8

​
MSSQLConfigStoreConfiguration

MSSQLConfigStoreConfiguration: Omit<SqlServerConnectionOptions, "type"> & ORMConfigStoreSharedConfiguration

​
Source

node/src/stores/MSSQL.ts:4

​
MariaDBConfigStoreConfiguration

MariaDBConfigStoreConfiguration: Omit<MysqlConnectionOptions, "type"> & ORMConfigStoreSharedConfiguration

​
Source

node/src/stores/MariaDB.ts:5

​
MySQLConfigStoreConfiguration

MySQLConfigStoreConfiguration: Omit<MysqlConnectionOptions, "type"> & ORMConfigStoreSharedConfiguration

​
Source

node/src/stores/MySQL.ts:4

​
PostgreSQLConfigStoreConfiguration

PostgreSQLConfigStoreConfiguration: Omit<PostgresConnectionOptions, "type"> & ORMConfigStoreSharedConfiguration

​
Source

node/src/stores/PostgreSQL.ts:4

​
SQLiteConfigStoreConfiguration

SQLiteConfigStoreConfiguration: Omit<SqliteConnectionOptions, "type"> & ORMConfigStoreSharedConfiguration

​
Source

node/src/stores/SQLite.ts:4

​
TomlFileConfigStoreConfiguration

TomlFileConfigStoreConfiguration: object

​
Type declaration

path

path: string

​
Source

node/src/stores/TomlFile.ts:6

​
XmlFileConfigStoreConfiguration

XmlFileConfigStoreConfiguration: object

​
Type declaration

builderOptions?

optional builderOptions: xml2js.BuilderOptions

path

path: string

​
Source

node/src/stores/XmlFile.ts:5

Was this page helpful?