Skip to main content

@webda/coreReadme | API


Type alias: UnpackedConfiguration

UnpackedConfiguration: Object

Type declaration

imports?

imports?: string[]

Include other configuration.json

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

openapi?

openapi?: Partial<OpenAPIV3.Document>

OpenAPI override

parameters?

parameters?: Object

Global parameters

Index signature

[key: string]: any

parameters.apiUrl?

parameters.apiUrl?: string

Define the api url

parameters.configurationService?

parameters.configurationService?: string

Read from the configuration service before init

parameters.csrfOrigins?

parameters.csrfOrigins?: string[]

Allowed origin for referer that match any of this regexp

OriginFilter

parameters.defaultStore?

parameters.defaultStore?: string

Define the default store

parameters.metrics?

parameters.metrics?: false | Object

Define metrics

parameters.requestLimit?

parameters.requestLimit?: number

Will not try to parse request bigger than this

This parameter can be overriden by a direct call to getHttpContext().getRawBody(xxx)

Default

10Mb

parameters.requestTimeout?

parameters.requestTimeout?: number

Will not take more than this to read a request (unit: milliseconds)

This parameter can be overriden by a direct call to getHttpContext().getRawBody(undefined, xxx)

Default

60000

parameters.static?

parameters.static?: StaticWebsite

Serve statically a website

parameters.trustedProxies?

parameters.trustedProxies?: string | string[]

Trust this reverse proxies

parameters.website?

parameters.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?

services?: any

Services configuration

version

version: 3

Source

packages/core/src/application.ts:195