@configu/lib Reference

​

Type Aliases

​

CiCd

CiCd: "GitHubActions" | "CircleCI" | "GitLabCICD" | "AzurePipelines" | "BitbucketPipelines" | "TeamCity" | "Buddy" | "Jenkins" | "Codefresh"

​

Source

integrations/cicd.ts:1

---

​

ConfigFormat

ConfigFormat: "JSON" | "CompactJSON" | "YAML" | "Dotenv" | "KubernetesConfigMap" | "HelmValues" | "TerraformTfvars" | "TOML"

​

Source

formatters/ConfigFormat.ts:1

---

​

Runtime

Runtime: "Heroku" | "Vercel" | "Netlify" | "Firebase" | "AwsLambda" | "AzureFunctions" | "GcpCloudFunctions" | "AwsEcs"

​

Source

integrations/runtime.ts:1

---

​

StoreType

StoreType: LiteralUnion<"noop" | "in-memory" | "configu" | "json-file" | "csv-file" | "ini-file" | "toml-file" | "xml-file" | "hashicorp-vault" | "aws-parameter-store" | "aws-secrets-manager" | "azure-key-vault" | "gcp-secret-manager" | "kubernetes-secret" | "sqlite" | "mysql" | "mariadb" | "postgres" | "cockroachdb" | "mssql" | "launch-darkly" | "cloud-bees" | "etcd", string>

​

Source

integrations/store.ts:3

​

Variables

​

CI_CD_LABEL

const CI_CD_LABEL: Record<CiCd, string>

​

Source

integrations/cicd.ts:12

---

​

CI_CD_TYPE

const CI_CD_TYPE: CiCd[]

​

Source

integrations/cicd.ts:35

---

​

CI_CD_WEBSITE

const CI_CD_WEBSITE: Record<CiCd, string>

​

Source

integrations/cicd.ts:23

---

​

CONFIG_FORMAT_EXTENSION

const CONFIG_FORMAT_EXTENSION: Record<ConfigFormat, string>

​

Source

formatters/ConfigFormat.ts:22

---

​

CONFIG_FORMAT_LABEL

const CONFIG_FORMAT_LABEL: Record<ConfigFormat, string>

​

Source

formatters/ConfigFormat.ts:11

---

​

CONFIG_FORMAT_TYPE

const CONFIG_FORMAT_TYPE: ConfigFormat[]

​

Source

formatters/ConfigFormat.ts:33

---

​

FOO

const FOO: object

​

Index signature

[key: string]: Cfgu

​

Source

schemas/foo.ts:3

---

​

GET_STARTED

const GET_STARTED: object

​

Index signature

[key: string]: Cfgu

​

Source

schemas/getStarted.ts:3

---

​

RUNTIME_LABEL

const RUNTIME_LABEL: Record<Runtime, string>

​

Source

integrations/runtime.ts:11

---

​

RUNTIME_TYPE

const RUNTIME_TYPE: Runtime[]

​

Source

integrations/runtime.ts:33

---

​

RUNTIME_WEBSITE

const RUNTIME_WEBSITE: Record<Runtime, string>

​

Source

integrations/runtime.ts:22

---

​

STORE_LABEL

const STORE_LABEL: Record<StoreType, string>

​

Source

integrations/store.ts:30

---

​

STORE_TYPE

const STORE_TYPE: StoreType[]

​

Source

integrations/store.ts:82

---

​

STORE_WEBSITE

const STORE_WEBSITE: Record<StoreType, string>

​

Source

integrations/store.ts:56

---

​

TYPES_CHECK_ORDER

const TYPES_CHECK_ORDER: CfguType[]

​

Source

extractors/configAnalyzer.ts:4

​

Functions

​

analyzeValueType()

analyzeValueType(value): CfguType

​

Parameters

• value: string

​

Returns

CfguType

​

Source

extractors/configAnalyzer.ts:26

---

​

extractConfigs()

extractConfigs(__namedParameters): Record<string, ExtractedConfig>

​

Parameters

• __namedParameters: ExtractConfigParameters

​

Returns

Record<string, ExtractedConfig>

​

Source

extractors/configExtractors.ts:47

---

​

formatConfigs()

formatConfigs(__namedParameters): string

​

Parameters

• __namedParameters: FormatterParameters & object

​

Returns

string

​

Source

formatters/configFormatters.ts:91