Skip to main content

UnpackedConfiguration

@webda/core

Type Alias: UnpackedConfiguration

UnpackedConfiguration = object

Defined in: packages/core/src/application/iconfiguration.ts:40

Properties​

$import?​

optional $import?: string[] | string

Defined in: packages/core/src/application/iconfiguration.ts:121

Include other configuration.json

This allow you to share Store definition or parameters between different components The configuration is merged with deepmerge(...imports, local)

application?​

optional application?: object

Defined in: packages/core/src/application/iconfiguration.ts:45

Configuration of core

configurationService?​

optional configurationService?: string

Read from the configuration service before init

Default​
"ConfigurationService"

defaultStore?​

optional defaultStore?: string

Define the default store

Default​
"Registry"

ignoreBeans?​

optional ignoreBeans?: boolean | string[]

Ignore beans

If set to true, all beans are ignored If set to an array, only the beans in the array are ignored

Default​
false

openapi?​

optional openapi?: Partial<OpenAPIV3.Document>

Defined in: packages/core/src/application/iconfiguration.ts:114

OpenAPI override

Should move to Router

parameters?​

optional parameters?: object

Defined in: packages/core/src/application/iconfiguration.ts:77

Global parameters

Shared between all services if it matches the service parameters

Index Signature​

[key: string]: any

Allow any other type of parameters

apiUrl?​

optional apiUrl?: string

Define the api url

metrics?​

optional metrics?: false | { config?: {[key: string]: any; }; labels?: {[key: string]: string; }; prefix?: string; }

Define metrics

static?​

optional static?: StaticWebsite

Serve statically a website

website?​

optional website?: string | string[]

Allow you to authorize one or several websites If you use "*" then the API is open to direct call and any origins You can also serve one static website by having a

WebsiteOriginFilter

services?​

optional services?: Record<string, any>

Defined in: packages/core/src/application/iconfiguration.ts:71

Services configuration

version​

version: 4

Defined in: packages/core/src/application/iconfiguration.ts:41