Docs
API
Modules
config_src

Table of contents

Type Aliases

Functions

Type Aliases

ConfigProcessOptions

Ƭ ConfigProcessOptions: Object

Type declaration

NameType
additionalPackagePrefixes?string[]
artifactsDir?string
configName?string
dir?string
generateCode?boolean
ignoreAdditionalResolvers?boolean
importFn?ImportFn
initialLoggerPrefix?string
store?MeshStore

Defined in

packages/config/src/process.ts:47


ProcessedConfig

Ƭ ProcessedConfig: Object

Type declaration

NameType
additionalEnvelopPluginsany[]
additionalResolversIResolvers[]
additionalTypeDefsDocumentNode[]
cacheKeyValueCache<string>
codestring
configConfig
documentsSource[]
loggerLogger
mergerMeshMerger
pubsubMeshPubSub
sourcesMeshResolvedSource[]
storeMeshStore
transformsMeshTransform[]

Defined in

packages/config/src/process.ts:61

Functions

getPackage

getPackage<T>(__namedParameters): Promise<ResolvedPackage<T>>

Type parameters

Name
T

Parameters

NameType
__namedParametersGetPackageOptions

Returns

Promise<ResolvedPackage<T>>


processConfig

processConfig(config, options?): Promise<ProcessedConfig>

Parameters

NameType
configConfig
options?ConfigProcessOptions

Returns

Promise<ProcessedConfig>


resolveAdditionalTypeDefs

resolveAdditionalTypeDefs(baseDir, additionalTypeDefs): Promise<DocumentNode[]>

Parameters

NameType
baseDirstring
additionalTypeDefsstring

Returns

Promise<DocumentNode[]>


resolveCache

resolveCache(cacheConfig?, importFn, rootStore, cwd, pubsub, logger, additionalPackagePrefixes): Promise<{ cache: KeyValueCache ; code: string ; importCode: string }>

Parameters

NameType
cacheConfigCache
importFnImportFn
rootStoreMeshStore
cwdstring
pubsubMeshPubSub
loggerLogger
additionalPackagePrefixesstring[]

Returns

Promise<{ cache: KeyValueCache ; code: string ; importCode: string }>


resolveCustomFetch

resolveCustomFetch(__namedParameters): Promise<{ code: string ; fetchFn: ReturnType<typeof fetchFactory> ; importCode: string }>

Parameters

NameType
__namedParametersObject
__namedParameters.additionalPackagePrefixesstring[]
__namedParameters.cacheKeyValueCache<any>
__namedParameters.cwdstring
__namedParameters.fetchConfig?string
__namedParameters.importFnImportFn

Returns

Promise<{ code: string ; fetchFn: ReturnType<typeof fetchFactory> ; importCode: string }>


resolveDocuments

resolveDocuments(documentsConfig, cwd): Promise<Source[]>

Parameters

NameType
documentsConfigstring[]
cwdstring

Returns

Promise<Source[]>


resolveLogger

resolveLogger(loggerConfig, importFn, cwd, additionalPackagePrefixes, initialLoggerPrefix?): Promise<{ code: string ; importCode: string ; logger: Logger }>

Parameters

NameTypeDefault value
loggerConfiganyundefined
importFnImportFnundefined
cwdstringundefined
additionalPackagePrefixesstring[]undefined
initialLoggerPrefixstring'🕸️ Mesh'

Returns

Promise<{ code: string ; importCode: string ; logger: Logger }>


resolvePubSub

resolvePubSub(pubsubYamlConfig, importFn, cwd, additionalPackagePrefixes): Promise<{ code: string ; importCode: string ; pubsub: MeshPubSub }>

Parameters

NameType
pubsubYamlConfigstring | PubSubConfig
importFnImportFn
cwdstring
additionalPackagePrefixesstring[]

Returns

Promise<{ code: string ; importCode: string ; pubsub: MeshPubSub }>