@morojs/moro


@morojs/moro / getConfig

Function: getConfig()

getConfig(): object

Defined in: src/core/config/utils.ts:22

Get the global configuration

Returns

object

database

database: object = DatabaseConfigSchema

database.mysql?

optional mysql: object

database.mysql.acquireTimeout

acquireTimeout: number

database.mysql.connectionLimit

connectionLimit: number

database.mysql.database?

optional database: string

database.mysql.host

host: string

database.mysql.password?

optional password: string

database.mysql.port

port: number

database.mysql.timeout

timeout: number

database.mysql.username?

optional username: string

database.redis

redis: object

database.redis.keyPrefix

keyPrefix: string

database.redis.maxRetries

maxRetries: number

database.redis.retryDelay

retryDelay: number

database.redis.url

url: string

database.url?

optional url: string

external

external: object = ExternalServicesConfigSchema

external.paypal?

optional paypal: object

external.paypal.clientId?

optional clientId: string

external.paypal.clientSecret?

optional clientSecret: string

external.paypal.environment

environment: "production" | "sandbox"

external.paypal.webhookId?

optional webhookId: string

external.smtp?

optional smtp: object

external.smtp.host?

optional host: string

external.smtp.password?

optional password: string

external.smtp.port

port: number

external.smtp.secure

secure: boolean

external.smtp.username?

optional username: string

external.stripe?

optional stripe: object

external.stripe.apiVersion

apiVersion: string

external.stripe.publishableKey?

optional publishableKey: string

external.stripe.secretKey?

optional secretKey: string

external.stripe.webhookSecret?

optional webhookSecret: string

logging

logging: object = LoggingConfigSchema

logging.enableColors

enableColors: boolean

logging.enableContext

enableContext: boolean

logging.enableTimestamp

enableTimestamp: boolean

logging.format

format: "pretty" | "json" | "compact"

logging.level

level: "debug" | "info" | "warn" | "error" | "fatal"

logging.outputs

outputs: object

logging.outputs.console

console: boolean

logging.outputs.file

file: object

logging.outputs.file.enabled

enabled: boolean

logging.outputs.file.maxFiles

maxFiles: number

logging.outputs.file.maxSize

maxSize: string

logging.outputs.file.path

path: string

logging.outputs.webhook

webhook: object

logging.outputs.webhook.enabled

enabled: boolean

logging.outputs.webhook.headers

headers: Record<string, string>

logging.outputs.webhook.url?

optional url: string

modules

modules: object = ModuleDefaultsConfigSchema

modules.cache

cache: object

modules.cache.defaultTtl

defaultTtl: number

modules.cache.enabled

enabled: boolean

modules.cache.maxSize

maxSize: number

modules.cache.strategy

strategy: "lru" | "lfu" | "fifo"

modules.rateLimit

rateLimit: object

modules.rateLimit.defaultRequests

defaultRequests: number

modules.rateLimit.defaultWindow

defaultWindow: number

modules.rateLimit.enabled

enabled: boolean

modules.rateLimit.skipFailedRequests

skipFailedRequests: boolean

modules.rateLimit.skipSuccessfulRequests

skipSuccessfulRequests: boolean

modules.validation

validation: object

modules.validation.abortEarly

abortEarly: boolean

modules.validation.enabled

enabled: boolean

modules.validation.stripUnknown

stripUnknown: boolean

performance

performance: object = PerformanceConfigSchema

performance.circuitBreaker

circuitBreaker: object

performance.circuitBreaker.enabled

enabled: boolean

performance.circuitBreaker.failureThreshold

failureThreshold: number

performance.circuitBreaker.monitoringPeriod

monitoringPeriod: number

performance.circuitBreaker.resetTimeout

resetTimeout: number

performance.clustering

clustering: object

performance.clustering.enabled

enabled: boolean

performance.clustering.workers

workers: number

performance.compression

compression: object

performance.compression.enabled

enabled: boolean

performance.compression.level

level: number

performance.compression.threshold

threshold: number

security

security: object = SecurityConfigSchema

security.cors

cors: object

security.cors.allowedHeaders

allowedHeaders: string[]

security.cors.credentials

credentials: boolean

security.cors.enabled

enabled: boolean

security.cors.methods

methods: string[]

security.cors.origin

origin: string | boolean | string[]

security.helmet

helmet: object

security.helmet.contentSecurityPolicy

contentSecurityPolicy: boolean

security.helmet.enabled

enabled: boolean

security.helmet.frameguard

frameguard: boolean

security.helmet.hsts

hsts: boolean

security.helmet.noSniff

noSniff: boolean

security.rateLimit

rateLimit: object

security.rateLimit.global

global: object

security.rateLimit.global.enabled

enabled: boolean

security.rateLimit.global.requests

requests: number

security.rateLimit.global.window

window: number

server

server: object = ServerConfigSchema

server.environment

environment: "production" | "development" | "staging"

server.host

host: string

server.maxConnections

maxConnections: number

server.port

port: number

server.timeout

timeout: number

serviceDiscovery

serviceDiscovery: object = ServiceDiscoveryConfigSchema

serviceDiscovery.consulUrl

consulUrl: string

serviceDiscovery.enabled

enabled: boolean

serviceDiscovery.healthCheckInterval

healthCheckInterval: number

serviceDiscovery.kubernetesNamespace

kubernetesNamespace: string

serviceDiscovery.retryAttempts

retryAttempts: number

serviceDiscovery.type

type: "memory" | "consul" | "kubernetes"