confound

Index

Interfaces

ConfigValueSources

Type aliases

Functions

configValueSource

Object literals

ConfigValueSources

Type aliases

ConfigFetcher

ConfigFetcher<T>: () => Promise<T>

Type parameters

T

Type declaration

- (): Promise<T>
- Returns Promise<T>

ConfigFor

ConfigFor<T>: {}

Type parameters

T

Type declaration

ConfigValueSource

ConfigValueSource<T>: ConfigFetcher<T> & { flatMap: <S>(f: (t: T) => ConfigValueSource<S>) => ConfigValueSource<S>; map: <S>(f: (t: T) => S | Promise<S>) => ConfigValueSource<S> }

Type parameters

T

Functions

Const configValueSource

configValueSource<T>(cf: ConfigFetcher<T>): (Anonymous function) & { flatMap: any; map: any }

- Defined in lib/confound.ts:10
Type parameters
- T
Parameters
- cf: ConfigFetcher<T>
Returns (Anonymous function) & { flatMap: any; map: any }

Object literals

Const ConfigValueSources

ConfigValueSources: object

env

env(n: string): ConfigValueSource<undefined | string>

- Defined in lib/confound.ts:29
Parameters
- n: string
Returns ConfigValueSource<undefined | string>

envOr

envOr(e: string, defaultVal: string): ConfigValueSource<string>

- Defined in lib/confound.ts:32
Parameters
- e: string
- defaultVal: string
Returns ConfigValueSource<string>

envOrDie

envOrDie(e: string): ConfigValueSource<string>

- Defined in lib/confound.ts:33
Parameters
- e: string
Returns ConfigValueSource<string>

lit

lit<T>(t: T | Promise<T>): ConfigValueSource<T>

- Defined in lib/confound.ts:28
Type parameters
- T
Parameters
- t: T | Promise<T>
Returns ConfigValueSource<T>

obj

obj<T>(config: ConfigFor<T>): ConfigValueSource<any>

- Defined in lib/confound.ts:34
Type parameters
- T
Parameters
- config: ConfigFor<T>
Returns ConfigValueSource<any>

of

of<T>(cf: () => Promise<T>): ConfigValueSource<T>

- Defined in lib/confound.ts:27
Type parameters
- T
Parameters
- cf: () => Promise<T>
  - - (): Promise<T>
    - Returns Promise<T>
Returns ConfigValueSource<T>

or

or<T>(cvs: ConfigValueSource<T | undefined>, defaultVal: T): ConfigValueSource<T>

- Defined in lib/confound.ts:30
Type parameters
- T
Parameters
- cvs: ConfigValueSource<T | undefined>
- defaultVal: T
Returns ConfigValueSource<T>

orDie

orDie<T>(cvs: ConfigValueSource<T | undefined>, failureMsg: string): ConfigValueSource<T>

- Defined in lib/confound.ts:31
Type parameters
- T
Parameters
- cvs: ConfigValueSource<T | undefined>
- failureMsg: string
Returns ConfigValueSource<T>

Generated using TypeDoc