Skip to main content

Interface: Environment

Defined in: packages/core/src/boot.ts:56

App environment for single env key.

Indexable​

[key: string]: unknown

Properties​

$App?​

optional $App: $AppSettings

Defined in: packages/core/src/boot.ts:61

$Debug​

$Debug: boolean

Defined in: packages/core/src/boot.ts:58

$Language​

$Language: Record<string, string>

Defined in: packages/core/src/boot.ts:59

$Resources()?​

optional $Resources: (response, manifest, defaultResources) => Resources

Defined in: packages/core/src/boot.ts:62

Parameters​

response​

unknown

manifest​

Manifest

defaultResources​

Resources

Returns​

Resources

$Server​

$Server: object

Defined in: packages/core/src/boot.ts:67

cache​

cache: object

cache.cacheKeyGenerator()?​

optional cache.cacheKeyGenerator: (req) => string

Parameters​
req​

Request

Returns​

string

cache.enabled​

cache.enabled: boolean | (req) => boolean

cache.entryTtl​

cache.entryTtl: number

cache.maxEntries​

cache.maxEntries: number

cache.unusedEntryTtl​

cache.unusedEntryTtl: number

clusters​

clusters: null | number

concurrency​

concurrency: number

host?​

optional host: string | (__namedParameters) => string

logger​

logger: object

logger.formatting​

logger.formatting: "dev" | "simple" | "JSON"

overloadConcurrency​

overloadConcurrency: number

port​

port: number

protocol?​

optional protocol: "http:" | "https:" | (__namedParameters) => "http:" | "https:"

serveSPA​

serveSPA: object

serveSPA.allow​

serveSPA.allow: boolean

serveSPA.blackList()?​

optional serveSPA.blackList: (userAgent) => boolean

Parameters​
userAgent​

string

Returns​

boolean

staticConcurrency​

staticConcurrency: number

staticPath​

staticPath: string

$Version​

$Version: string

Defined in: packages/core/src/boot.ts:60