​
Enumerations

​
EvaluatedConfigOrigin

​
Enumeration Members

ConfigsOverride

ConfigsOverride: "CONFIGS_OVERRIDE"

Source

packages/ts/src/commands/EvalCommand.ts:10

EmptyValue

EmptyValue: "EMPTY_VALUE"

Source

packages/ts/src/commands/EvalCommand.ts:14

SchemaDefault

SchemaDefault: "SCHEMA_DEFAULT"

Source

packages/ts/src/commands/EvalCommand.ts:13

SchemaTemplate

SchemaTemplate: "SCHEMA_TEMPLATE"

Source

packages/ts/src/commands/EvalCommand.ts:12

StoreSet

StoreSet: "STORE_SET"

Source

packages/ts/src/commands/EvalCommand.ts:11

​
Classes

​
abstract Command<T>

​
Extended by

​
Type parameters

• T

​
Constructors

new Command()

new Command<T>(parameters): Command<T>

Parameters

• parameters: Record<string, unknown>

Returns

Command<T>

Source

packages/ts/src/Command.ts:2

​
Properties

parameters

parameters: Record<string, unknown>

Source

packages/ts/src/Command.ts:2

​
Methods

run()

abstract run(): Promise<T>

Returns

Promise<T>

Source

packages/ts/src/Command.ts:3

​
ConfigError

​
Extends

  • Error

​
Extended by

​
Constructors

new ConfigError()

new ConfigError(reason, hint, scope): ConfigError

Parameters

• reason: string

• hint: string= ''

• scope: [string, string][]= []

Returns

ConfigError

Overrides

Error.constructor

Source

packages/ts/src/utils.ts:8

​
Properties

hint

protected readonly hint: string = ''

Source

packages/ts/src/utils.ts:10

reason

protected readonly reason: string

Source

packages/ts/src/utils.ts:9

scope

protected readonly scope: [string, string][] = []

Source

packages/ts/src/utils.ts:11

​
Methods

appendScope()

appendScope(scope): ConfigError

Parameters

• scope: [string, string][]

Returns

ConfigError

Source

packages/ts/src/utils.ts:32

setHint()

setHint(hint): ConfigError

Parameters

• hint: string

Returns

ConfigError

Source

packages/ts/src/utils.ts:28

setReason()

setReason(reason): ConfigError

Parameters

• reason: string

Returns

ConfigError

Source

packages/ts/src/utils.ts:24

​
ConfigSchema

A file containing binding records linking each unique ConfigKey to its corresponding Cfgu declaration. https://configu.com/docs/config-schema/

​
Implements

​
Constructors

new ConfigSchema()

new ConfigSchema(name, contents): ConfigSchema

Parameters

• name: string

• contents

Returns

ConfigSchema

Source

packages/ts/src/ConfigSchema.ts:421

​
Properties

contents

readonly contents: object

Index signature

[key: string]: Cfgu

Implementation of

IConfigSchema.contents

Source

packages/ts/src/ConfigSchema.ts:423

name

readonly name: string

Implementation of

IConfigSchema.name

Source

packages/ts/src/ConfigSchema.ts:422

CFGU

static CFGU: object

NAME

NAME: string = CFGU_NAME

PROPS

PROPS: keyof Cfgu[] = CFGU_PROP

VALIDATORS

VALIDATORS: object

VALIDATORS.TYPE

TYPE: Record<CfguType, (parameters) => boolean> = CFGU_VALUE_TYPE_VALIDATORS

VALIDATORS.structure()

structure: (cfgu) => void = cfguStructureValidator

Parameters

• cfgu: Cfgu

Returns

void

VALIDATORS.valueOptions()

valueOptions: (cfgu, value) => void = cfguValueOptionsValidator

Parameters

• cfgu: Cfgu

• value: string

Returns

void

VALIDATORS.valueType()

valueType: (cfgu, value) => void = cfguValueTypeValidator

Parameters

• cfgu: Cfgu

• value: string

Returns

void

Source

packages/ts/src/ConfigSchema.ts:410

​
ConfigSet

A unique, case-sensitive path within a tree-like data structure that groups Configs contextually. https://configu.com/docs/config-set/

​
Implements

​
Constructors

new ConfigSet()

new ConfigSet(path): ConfigSet

Parameters

• path: string= ConfigSet.ROOT

Returns

ConfigSet

Source

packages/ts/src/ConfigSet.ts:12

​
Properties

hierarchy

readonly hierarchy: string[] = []

Implementation of

IConfigSet.hierarchy

Source

packages/ts/src/ConfigSet.ts:10

path

readonly path: string = ConfigSet.ROOT

Implementation of

IConfigSet.path

Source

packages/ts/src/ConfigSet.ts:12

ROOT

static ROOT: ""

Source

packages/ts/src/ConfigSet.ts:7

ROOT_LABEL

static ROOT_LABEL: "/"

Source

packages/ts/src/ConfigSet.ts:8

SEPARATOR

static SEPARATOR: "/"

Source

packages/ts/src/ConfigSet.ts:6

​
abstract ConfigStore

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

​
Extended by

​
Implements

​
Constructors

new ConfigStore()

new ConfigStore(type): ConfigStore

Parameters

• type: string

Returns

ConfigStore

Source

packages/ts/src/ConfigStore.ts:4

​
Properties

type

readonly type: string

Implementation of

IConfigStore.type

Source

packages/ts/src/ConfigStore.ts:4

​
Methods

get()

abstract get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Source

packages/ts/src/ConfigStore.ts:7

init()

init(): Promise<void>

Returns

Promise<void>

Source

packages/ts/src/ConfigStore.ts:6

set()

abstract set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Source

packages/ts/src/ConfigStore.ts:8

​
ConfigStoreError

​
Extends

​
Constructors

new ConfigStoreError()

new ConfigStoreError(reason, hint, scope): ConfigStoreError

Parameters

• reason: string

• hint: string= ''

• scope: [string, string][]= []

Returns

ConfigStoreError

Inherited from

ConfigError.constructor

Source

packages/ts/src/utils.ts:8

​
Properties

hint

protected readonly hint: string = ''

Inherited from

ConfigError.hint

Source

packages/ts/src/utils.ts:10

reason

protected readonly reason: string

Inherited from

ConfigError.reason

Source

packages/ts/src/utils.ts:9

scope

protected readonly scope: [string, string][] = []

Inherited from

ConfigError.scope

Source

packages/ts/src/utils.ts:11

​
Methods

appendScope()

appendScope(scope): ConfigError

Parameters

• scope: [string, string][]

Returns

ConfigError

Inherited from

ConfigError.appendScope

Source

packages/ts/src/utils.ts:32

setHint()

setHint(hint): ConfigError

Parameters

• hint: string

Returns

ConfigError

Inherited from

ConfigError.setHint

Source

packages/ts/src/utils.ts:28

setReason()

setReason(reason): ConfigError

Parameters

• reason: string

Returns

ConfigError

Inherited from

ConfigError.setReason

Source

packages/ts/src/utils.ts:24

​
ConfiguConfigStore

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

​
Extends

​
Constructors

new ConfiguConfigStore()

new ConfiguConfigStore(__namedParameters): ConfiguConfigStore

Parameters

• __namedParameters: ConfiguConfigStoreConfiguration

Returns

ConfiguConfigStore

Overrides

ConfigStore.constructor

Source

packages/ts/src/stores/Configu.ts:27

​
Properties

tag?

optional tag: string

Source

packages/ts/src/stores/Configu.ts:26

type

readonly type: string

Inherited from

ConfigStore.type

Source

packages/ts/src/ConfigStore.ts:4

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Overrides

ConfigStore.get

Source

packages/ts/src/stores/Configu.ts:53

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ConfigStore.init

Source

packages/ts/src/ConfigStore.ts:6

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Overrides

ConfigStore.set

Source

packages/ts/src/stores/Configu.ts:58

​
ConfiguConfigStoreApprovalQueueError

​
Extends

  • Error

​
Constructors

new ConfiguConfigStoreApprovalQueueError()

new ConfiguConfigStoreApprovalQueueError(protectedSet, queueUrl): ConfiguConfigStoreApprovalQueueError

Parameters

• protectedSet: string

• queueUrl: string

Returns

ConfiguConfigStoreApprovalQueueError

Overrides

Error.constructor

Source

packages/ts/src/stores/Configu.ts:15

​
Properties

queueUrl

readonly queueUrl: string

Source

packages/ts/src/stores/Configu.ts:14

​
Convert

​
Constructors

new Convert()

new Convert(): Convert

Returns

Convert

​
Methods

cfguToJson()

static cfguToJson(value): string

Parameters

• value: Cfgu

Returns

string

Source

packages/ts/src/types/generated.ts:158

cfguTypeToJson()

static cfguTypeToJson(value): string

Parameters

• value: CfguType

Returns

string

Source

packages/ts/src/types/generated.ts:150

configSchemaContentsToJson()

static configSchemaContentsToJson(value): string

Parameters

• value

Returns

string

Source

packages/ts/src/types/generated.ts:182

configSchemaContentsValueToJson()

static configSchemaContentsValueToJson(value): string

Parameters

• value: ConfigSchemaContents

Returns

string

Source

packages/ts/src/types/generated.ts:174

configSchemaToJson()

static configSchemaToJson(value): string

Parameters

• value: IConfigSchema

Returns

string

Source

packages/ts/src/types/generated.ts:190

configSetToJson()

static configSetToJson(value): string

Parameters

• value: IConfigSet

Returns

string

Source

packages/ts/src/types/generated.ts:198

configStoreContentsElementToJson()

static configStoreContentsElementToJson(value): string

Parameters

• value: ConfigStoreContents

Returns

string

Source

packages/ts/src/types/generated.ts:214

configStoreContentsToJson()

static configStoreContentsToJson(value): string

Parameters

• value: ConfigStoreContents[]

Returns

string

Source

packages/ts/src/types/generated.ts:222

configStoreQueryToJson()

static configStoreQueryToJson(value): string

Parameters

• value: ConfigStoreQuery

Returns

string

Source

packages/ts/src/types/generated.ts:206

configStoreToJson()

static configStoreToJson(value): string

Parameters

• value: IConfigStore

Returns

string

Source

packages/ts/src/types/generated.ts:230

configToJson()

static configToJson(value): string

Parameters

• value: Config

Returns

string

Source

packages/ts/src/types/generated.ts:166

toCfgu()

static toCfgu(json): Cfgu

Parameters

• json: string

Returns

Cfgu

Source

packages/ts/src/types/generated.ts:154

toCfguType()

static toCfguType(json): CfguType

Parameters

• json: string

Returns

CfguType

Source

packages/ts/src/types/generated.ts:146

toConfig()

static toConfig(json): Config

Parameters

• json: string

Returns

Config

Source

packages/ts/src/types/generated.ts:162

toConfigSchema()

static toConfigSchema(json): IConfigSchema

Parameters

• json: string

Returns

IConfigSchema

Source

packages/ts/src/types/generated.ts:186

toConfigSchemaContents()

static toConfigSchemaContents(json): object

Parameters

• json: string

Returns

object

Source

packages/ts/src/types/generated.ts:178

toConfigSchemaContentsValue()

static toConfigSchemaContentsValue(json): ConfigSchemaContents

Parameters

• json: string

Returns

ConfigSchemaContents

Source

packages/ts/src/types/generated.ts:170

toConfigSet()

static toConfigSet(json): IConfigSet

Parameters

• json: string

Returns

IConfigSet

Source

packages/ts/src/types/generated.ts:194

toConfigStore()

static toConfigStore(json): IConfigStore

Parameters

• json: string

Returns

IConfigStore

Source

packages/ts/src/types/generated.ts:226

toConfigStoreContents()

static toConfigStoreContents(json): ConfigStoreContents[]

Parameters

• json: string

Returns

ConfigStoreContents[]

Source

packages/ts/src/types/generated.ts:218

toConfigStoreContentsElement()

static toConfigStoreContentsElement(json): ConfigStoreContents

Parameters

• json: string

Returns

ConfigStoreContents

Source

packages/ts/src/types/generated.ts:210

toConfigStoreQuery()

static toConfigStoreQuery(json): ConfigStoreQuery

Parameters

• json: string

Returns

ConfigStoreQuery

Source

packages/ts/src/types/generated.ts:202

​
DeleteCommand

​
Extends

​
Constructors

new DeleteCommand()

new DeleteCommand(parameters): DeleteCommand

Parameters

• parameters: DeleteCommandParameters

Returns

DeleteCommand

Overrides

Command.constructor

Source

packages/ts/src/commands/DeleteCommand.ts:15

​
Properties

parameters

parameters: DeleteCommandParameters

Inherited from

Command.parameters

Source

packages/ts/src/commands/DeleteCommand.ts:15

​
Methods

run()

run(): Promise<void>

Returns

Promise<void>

Overrides

Command.run

Source

packages/ts/src/commands/DeleteCommand.ts:19

​
EvalCommand

​
Extends

​
Constructors

new EvalCommand()

new EvalCommand(parameters): EvalCommand

Parameters

• parameters: EvalCommandParameters

Returns

EvalCommand

Overrides

Command.constructor

Source

packages/ts/src/commands/EvalCommand.ts:34

​
Properties

parameters

parameters: EvalCommandParameters

Inherited from

Command.parameters

Source

packages/ts/src/commands/EvalCommand.ts:34

​
Methods

run()

run(): Promise<object>

Returns

Promise<object>

Overrides

Command.run

Source

packages/ts/src/commands/EvalCommand.ts:270

​
ExportCommand

​
Extends

​
Extended by

​
Constructors

new ExportCommand()

new ExportCommand(parameters): ExportCommand

Parameters

• parameters: ExportCommandParameters

Returns

ExportCommand

Overrides

Command.constructor

Source

packages/ts/src/commands/ExportCommand.ts:17

​
Properties

parameters

parameters: ExportCommandParameters

Inherited from

Command.parameters

Source

packages/ts/src/commands/ExportCommand.ts:17

​
Methods

run()

run(): Promise<object>

Returns

Promise<object>

Overrides

Command.run

Source

packages/ts/src/commands/ExportCommand.ts:49

​
InMemoryConfigStore

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

​
Extends

​
Constructors

new InMemoryConfigStore()

new InMemoryConfigStore(): InMemoryConfigStore

Returns

InMemoryConfigStore

Overrides

ConfigStore.constructor

Source

packages/ts/src/stores/InMemory.ts:8

​
Properties

type

readonly type: string

Inherited from

ConfigStore.type

Source

packages/ts/src/ConfigStore.ts:4

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Overrides

ConfigStore.get

Source

packages/ts/src/stores/InMemory.ts:12

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ConfigStore.init

Source

packages/ts/src/ConfigStore.ts:6

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Overrides

ConfigStore.set

Source

packages/ts/src/stores/InMemory.ts:20

​
abstract KeyValueConfigStore

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

​
Extends

​
Extended by

​
Constructors

new KeyValueConfigStore()

new KeyValueConfigStore(type): KeyValueConfigStore

Parameters

• type: string

Returns

KeyValueConfigStore

Overrides

ConfigStore.constructor

Source

packages/ts/src/stores/KeyValue.ts:6

​
Properties

type

readonly type: string

Inherited from

ConfigStore.type

Source

packages/ts/src/ConfigStore.ts:4

​
Methods

delete()

protected abstract delete(key): Promise<void>

Parameters

• key: string

Returns

Promise<void>

Source

packages/ts/src/stores/KeyValue.ts:14

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Overrides

ConfigStore.get

Source

packages/ts/src/stores/KeyValue.ts:40

getByKey()

protected abstract getByKey(key): Promise<string>

Parameters

• key: string

Returns

Promise<string>

Source

packages/ts/src/stores/KeyValue.ts:10

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ConfigStore.init

Source

packages/ts/src/ConfigStore.ts:6

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Overrides

ConfigStore.set

Source

packages/ts/src/stores/KeyValue.ts:82

upsert()

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

Parameters

• key: string

• value: string

Returns

Promise<void>

Source

packages/ts/src/stores/KeyValue.ts:12

​
NoopConfigStore

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

​
Extends

​
Constructors

new NoopConfigStore()

new NoopConfigStore(): NoopConfigStore

Returns

NoopConfigStore

Overrides

ConfigStore.constructor

Source

packages/ts/src/stores/Noop.ts:5

​
Properties

type

readonly type: string

Inherited from

ConfigStore.type

Source

packages/ts/src/ConfigStore.ts:4

​
Methods

get()

get(queries): Promise<Config[]>

Parameters

• queries: ConfigStoreQuery[]

Returns

Promise<Config[]>

Overrides

ConfigStore.get

Source

packages/ts/src/stores/Noop.ts:9

init()

init(): Promise<void>

Returns

Promise<void>

Inherited from

ConfigStore.init

Source

packages/ts/src/ConfigStore.ts:6

set()

set(configs): Promise<void>

Parameters

• configs: Config[]

Returns

Promise<void>

Overrides

ConfigStore.set

Source

packages/ts/src/stores/Noop.ts:13

​
TestCommand

​
Extends

​
Constructors

new TestCommand()

new TestCommand(parameters): TestCommand

Parameters

• parameters: TestCommandParameters

Returns

TestCommand

Overrides

Command.constructor

Source

packages/ts/src/commands/TestCommand.ts:13

​
Properties

parameters

parameters: TestCommandParameters

Inherited from

Command.parameters

Source

packages/ts/src/commands/TestCommand.ts:13

​
Methods

run()

run(): Promise<void>

Returns

Promise<void>

Overrides

Command.run

Source

packages/ts/src/commands/TestCommand.ts:17

​
UpsertCommand

​
Extends

​
Constructors

new UpsertCommand()

new UpsertCommand(parameters): UpsertCommand

Parameters

• parameters: UpsertCommandParameters

Returns

UpsertCommand

Overrides

Command.constructor

Source

packages/ts/src/commands/UpsertCommand.ts:19

​
Properties

parameters

parameters: UpsertCommandParameters

Inherited from

Command.parameters

Source

packages/ts/src/commands/UpsertCommand.ts:19

​
Methods

run()

run(): Promise<void>

Returns

Promise<void>

Overrides

Command.run

Source

packages/ts/src/commands/UpsertCommand.ts:23

​
Interfaces

​
Cfgu

A generic declaration of a Config, using properties like type, description and constraints. https://configu.com/docs/cfgu/

​
Properties

default?

optional default: string

Source

packages/ts/src/types/generated.ts:26

depends?

optional depends: string[]

Source

packages/ts/src/types/generated.ts:27

description?

optional description: string

Source

packages/ts/src/types/generated.ts:28

hidden?

optional hidden: boolean

Source

packages/ts/src/types/generated.ts:29

labels?

optional labels: string[]

Source

packages/ts/src/types/generated.ts:30

lazy?

optional lazy: boolean

Source

packages/ts/src/types/generated.ts:31

options?

optional options: string[]

Source

packages/ts/src/types/generated.ts:32

pattern?

optional pattern: string

Source

packages/ts/src/types/generated.ts:33

required?

optional required: boolean

Source

packages/ts/src/types/generated.ts:34

schema?

optional schema: object

Index signature

[key: string]: any

Source

packages/ts/src/types/generated.ts:35

template?

optional template: string

Source

packages/ts/src/types/generated.ts:36

type

type: CfguType

Source

packages/ts/src/types/generated.ts:37

​
Config

A generic representation of application configuration using three properties: key, value, set. https://configu.com/docs/terminology/#config

​
Properties

key

key: string

Source

packages/ts/src/types/generated.ts:84

set

set: string

Source

packages/ts/src/types/generated.ts:85

value

value: string

Source

packages/ts/src/types/generated.ts:86

​
ConfigStoreQuery

​
Properties

key

key: string

Source

packages/ts/src/types/generated.ts:125

set

set: string

Source

packages/ts/src/types/generated.ts:126

​
IConfigSchema

A file containing binding records linking each unique ConfigKey to its corresponding Cfgu declaration. https://configu.com/docs/config-schema/

​
Properties

contents

contents: object

Index signature

[key: string]: ConfigSchemaContents

Source

packages/ts/src/types/generated.ts:95

name

name: string

Source

packages/ts/src/types/generated.ts:96

​
IConfigSet

A unique, case-sensitive path within a tree-like data structure that groups Configs contextually. https://configu.com/docs/config-set/

​
Properties

hierarchy

hierarchy: string[]

Source

packages/ts/src/types/generated.ts:120

path

path: string

Source

packages/ts/src/types/generated.ts:121

​
IConfigStore

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

​
Properties

type

type: string

Source

packages/ts/src/types/generated.ts:140

​
Type Aliases

​
CfguType

CfguType: "ARN" | "AWSRegion" | "AZRegion" | "AlibabaRegion" | "Base64" | "Boolean" | "Color" | "Country" | "Currency" | "DateTime" | "DockerImage" | "Domain" | "Email" | "GCPRegion" | "Hex" | "IBMRegion" | "IPv4" | "IPv6" | "JSONSchema" | "Language" | "LatLong" | "Locale" | "MACAddress" | "MD5" | "MIMEType" | "MobilePhone" | "MongoId" | "Number" | "OracleRegion" | "RegEx" | "SHA" | "SemVer" | "String" | "URL" | "UUID"

​
Source

packages/ts/src/types/generated.ts:40

​
ConfigSchemaContents

ConfigSchemaContents: object

​
Index signature

[ConfigKey: string]: Cfgu

​
Source

packages/ts/src/Cfgu.ts:208

​
ConfiguConfigStoreConfiguration

ConfiguConfigStoreConfiguration: object

​
Type declaration

credentials

credentials: object

credentials.org

org: string

credentials.token

token: string

endpoint?

optional endpoint: string

source?

optional source: string

tag?

optional tag: string

​
Source

packages/ts/src/stores/Configu.ts:6

​
DeleteCommandParameters

DeleteCommandParameters: object

​
Type declaration

schema

schema: ConfigSchema

set

set: ConfigSet

store

store: ConfigStore

​
Source

packages/ts/src/commands/DeleteCommand.ts:8

​
EvalCommandParameters

EvalCommandParameters: object

​
Type declaration

configs?

optional configs: object

Index signature

[key: string]: string

pipe?

optional pipe: EvalCommandReturn

schema

schema: ConfigSchema

set

set: ConfigSet

store

store: ConfigStore

validate?

optional validate: boolean

​
Source

packages/ts/src/commands/EvalCommand.ts:24

​
EvalCommandReturn

EvalCommandReturn: object

​
Index signature

[key: string]: object

​
Source

packages/ts/src/commands/EvalCommand.ts:17

​
ExportCommandParameters

ExportCommandParameters: object

​
Type declaration

filter()?

optional filter: ({ context, result }) => boolean

Parameters

• { context, result }: EvalCommandReturn["string"]

Returns

boolean

keys()?

optional keys: (key) => string

Parameters

• key: string

Returns

string

pipe

pipe: EvalCommandReturn

​
Source

packages/ts/src/commands/ExportCommand.ts:10

​
ExportCommandReturn

ExportCommandReturn: object

​
Index signature

[key: string]: string

​
Source

packages/ts/src/commands/ExportCommand.ts:6

​
JsonSchemaObject

JsonSchemaObject: SchemaObject

​
Source

packages/ts/src/Cfgu.ts:4

​
JsonSchemaType<T>

JsonSchemaType<T>: JSONSchemaType<T>

​
Type parameters

• T

​
Source

packages/ts/src/Cfgu.ts:3

​
TestCommandParameters

TestCommandParameters: object

​
Type declaration

clean?

optional clean: boolean

store

store: ConfigStore

​
Source

packages/ts/src/commands/TestCommand.ts:7

​
UpsertCommandParameters

UpsertCommandParameters: object

​
Type declaration

configs?

optional configs: object

Index signature

[key: string]: string

pipe?

optional pipe: EvalCommandReturn

schema

schema: ConfigSchema

set

set: ConfigSet

store

store: ConfigStore

​
Source

packages/ts/src/commands/UpsertCommand.ts:10

​
Variables

​
CfguSchema

const CfguSchema: JsonSchemaType<Cfgu>

​
Source

packages/ts/src/Cfgu.ts:94

​
CfguSchemaDefs

const CfguSchemaDefs: object

​
Type declaration

ArrayProperty

readonly ArrayProperty: object

ArrayProperty.items

readonly items: object

ArrayProperty.items.minLength

readonly minLength: 1 = 1

ArrayProperty.items.type

readonly type: "string" = 'string'

ArrayProperty.minItems

readonly minItems: 1 = 1

ArrayProperty.nullable

readonly nullable: true = true

ArrayProperty.type

readonly type: "array" = 'array'

ArrayProperty.uniqueItems

readonly uniqueItems: true = true

BooleanProperty

readonly BooleanProperty: object

BooleanProperty.nullable

readonly nullable: true = true

BooleanProperty.type

readonly type: "boolean" = 'boolean'

ConfigKey

readonly ConfigKey: object

ConfigKey.minLength

readonly minLength: 1 = 1

ConfigKey.pattern

readonly pattern: "^[A-Za-z0-9_-]+$" = NamingPattern

ConfigKey.type

readonly type: "string" = 'string'

StringProperty

readonly StringProperty: object

StringProperty.minLength

readonly minLength: 1 = 1

StringProperty.nullable

readonly nullable: true = true

StringProperty.type

readonly type: "string" = 'string'

​
Source

packages/ts/src/Cfgu.ts:67

​
CfguTypes

const CfguTypes: readonly ["Boolean", "Number", "String", "RegEx", "UUID", "SemVer", "IPv4", "IPv6", "Domain", "URL", "Hex", "Base64", "MD5", "SHA", "Color", "Email", "MobilePhone", "Locale", "LatLong", "Country", "Currency", "DockerImage", "MACAddress", "MIMEType", "MongoId", "AWSRegion", "AZRegion", "GCPRegion", "OracleRegion", "IBMRegion", "AlibabaRegion", "Language", "DateTime", "ARN", "JSONSchema"]

​
Source

packages/ts/src/Cfgu.ts:8

​
ConfigSchemaContents

ConfigSchemaContents: JsonSchemaType<ConfigSchemaContents>

​
Source

packages/ts/src/Cfgu.ts:208

​
MetaSchema

const MetaSchema: JsonSchemaType<object>

​
Type declaration

$schema?

optional $schema: string

​
Source

packages/ts/src/Cfgu.ts:226

​
NamingPattern

const NamingPattern: "^[A-Za-z0-9_-]+$" = '^[A-Za-z0-9_-]+$'

​
Source

packages/ts/src/Cfgu.ts:6

​
TMPL

const TMPL: object

​
Type declaration

parse()

parse: (template) => object[]

Parameters

• template: string

Returns

object[]

render()

render: (template, context) => string

Parameters

• template: string

• context: any

Returns

string

​
Source

packages/ts/src/utils.ts:47

​
bla

const bla: "bla" = 'bla'

​
Source

packages/ts/src/utils.ts:5

​
Functions

​
JSON_SCHEMA()

JSON_SCHEMA(schema, value): boolean

​
Parameters

• schema: SchemaObject

• value: any

​
Returns

boolean

​
Source

packages/ts/src/utils.ts:65

​
NAME()

NAME(name): boolean

​
Parameters

• name: string

​
Returns

boolean

​
Source

packages/ts/src/utils.ts:43

​
REGEX()

REGEX(pattern, string): boolean

​
Parameters

• pattern: string | RegExp

• string: string

​
Returns

boolean

​
Source

packages/ts/src/utils.ts:39

Was this page helpful?