Class WebdaConfiguration

Hierarchy

WebdaServer
- WebdaConfiguration

Constructors

Properties

_ajv

_currentExecutor

_init

_initTime

_requestFilters

devMode

router

webdaApplication

defaultMaxListeners

Methods

addRoute

autoConnectServices

emit

emitSync

flush

getConfiguration

getGlobalParams

getLogger

getMaxListeners

getModel

getModels

getRouter

getSalt

getSecret

getServerStatus

getServiceParams

getServicesImplementations

getStores

getWebdaApplication

getWorkerOutput

handleStaticIndexRequest

init

isDebug

listeners

log

off

on

once

output

parameter

prependListener

prependOnceListener

registerRequestFilter

reinit

reinitResolvedRoutes

removeAllListeners

sandbox

serve

serveStaticWebsite

setMaxListeners

stop

updateContextWithRoute

validate

validationLastErrors

Constructors

new WebdaConfiguration(application: Application): WebdaConfiguration

Overrides LambdaServer.constructor

Parameters
- application: Application
Returns WebdaConfiguration
- Defined in packages/shell/src/handlers/config.ts:102

Properties

_ajv: any

JSON Schema validator instance

_ajvSchemas: any

JSON Schema registry

_configFile: string

_currentExecutor: any

Current executor

_init: Promise<void>

Init promise to ensure, webda is initiated Used for init() method

_initPromise: Promise<void>

_initTime: number

_initiated: boolean

_requestFilters: RequestFilter<Context>[]

CORS Filter registry

Added via [[Webda.registerRequestFilter]] See [[CorsFilter]]

application: Application

devMode: boolean

failedServices: object

Type declaration

[key: string]: any

router: Router

serverStatus: ServerStatus = ServerStatus.Stopped

staticIndex: string

webdaApplication: Application

defaultMaxListeners: number

Methods

_getSetters(obj: any): any[]

Inherited from LambdaServer._getSetters

Return all methods that are setters (startsWith("set"))

Parameters
- obj: any
  
  service get setter from
Returns any[]
- Defined in packages/core/lib/core.d.ts:381

addListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.addListener

Overrides EventEmitter.addListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:32
Returns this
- Defined in node_modules/@types/node/events.d.ts:32

addRoute(url: string, info: RouteInfo): void

Inherited from LambdaServer.addRoute

Add a route dynamicaly

Parameters
- url: string
  
  of the route can contains dynamic part like {uuid}
- info: RouteInfo
  
  the type of executor
Returns void
- Defined in packages/core/lib/core.d.ts:276

autoConnectServices(): void

Inherited from LambdaServer.autoConnectServices

Auto connect services with setters

Returns void
- Defined in packages/core/lib/core.d.ts:385

checkRequest(ctx: Context): Promise<boolean>

Inherited from LambdaServer.checkRequest

Verify if an origin is allowed to do request on the API

Parameters
- ctx: Context
Returns Promise<boolean>
- Defined in packages/core/lib/core.d.ts:428

emit(event: string | symbol, ...args: any[]): boolean

Inherited from CloudWatchLogger.emit

Overrides EventEmitter.emit

Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in node_modules/@types/node/events.d.ts:44

emitSync(event: any, ...data: any[]): Promise<any[]>

Inherited from LambdaServer.emitSync

Emit the event with data and wait for Promise to finish if listener returned a Promise

Parameters
- event: any
- Rest ...data: any[]
Returns Promise<any[]>
- Defined in packages/core/lib/core.d.ts:412

eventNames(): Array<string | symbol>

Inherited from CloudWatchLogger.eventNames

Overrides EventEmitter.eventNames

Returns Array<string | symbol>
- Defined in node_modules/@types/node/events.d.ts:45

exportOpenAPI(skipHidden?: boolean): Document

Inherited from LambdaServer.exportOpenAPI

Parameters
- Optional skipHidden: boolean
Returns Document
- Defined in packages/core/lib/core.d.ts:429

flush(ctx: any): void

Inherited from WebdaServer.flush

Overrides Core.flush

Parameters
- ctx: any
Returns void
- Defined in packages/shell/src/handlers/http.ts:172

flushHeaders(ctx: any): void

Inherited from WebdaServer.flushHeaders

Overrides Core.flushHeaders

Parameters
- ctx: any
Returns void
- Defined in packages/shell/src/handlers/http.ts:162

getAppPath(subpath?: string): string

Inherited from LambdaServer.getAppPath

Parameters
- Optional subpath: string
Returns string
- Defined in packages/core/lib/core.d.ts:205

getApplication(): Application

Inherited from LambdaServer.getApplication

Return application definition

Returns Application
- Defined in packages/core/lib/core.d.ts:223

getClientInfo(req: any): ClientInfo

Inherited from WebdaServer.getClientInfo

Initialize a ClientInfo structure based on request

Parameters
- req: any
Returns ClientInfo
- Defined in packages/shell/src/handlers/http.ts:35

getConfiguration(): Configuration

Inherited from LambdaServer.getConfiguration

Returns Configuration
- Defined in packages/core/lib/core.d.ts:308

getDeployers(): object

Inherited from LambdaServer.getDeployers

Retrieve all deployers

Returns object
- [key: string]: ServiceConstructor<Service<ServiceParameters>>
- Defined in packages/core/lib/core.d.ts:217

getGlobalParams(): any

Inherited from LambdaServer.getGlobalParams

Return the global parameters of a domain

Returns any
- Defined in packages/core/lib/core.d.ts:369

getLocales(): string[]

Inherited from LambdaServer.getLocales

To define the locales just add a locales: ['en-GB', 'fr-FR'] in your host global configuration

Returns string[]

The configured locales or "en-GB" if none are defined
- Defined in packages/core/lib/core.d.ts:264

getLogger(clazz: string | Service): Logger

Inherited from LambdaServer.getLogger

Get a Logger for a class

Parameters
- clazz: string | Service
Returns Logger
- Defined in packages/core/lib/core.d.ts:269

getMaxListeners(): number

Inherited from CloudWatchLogger.getMaxListeners

Overrides EventEmitter.getMaxListeners

Returns number
- Defined in node_modules/@types/node/events.d.ts:41

getModel(name: any): any

Inherited from LambdaServer.getModel

Check for a model name and return the wanted class or throw exception if none found

Parameters
- name: any
  
  The model name to retrieve
Returns any
- Defined in packages/core/lib/core.d.ts:332

getModels(): object

Inherited from LambdaServer.getModels

Return a map of defined models

Returns object
- [key: string]: CoreModelDefinition
- Defined in packages/core/lib/core.d.ts:320

getModules(): CachedModule

Inherited from LambdaServer.getModules

Retrieve all detected modules definition

Returns CachedModule
- Defined in packages/core/lib/core.d.ts:213

getRouter(): Router

Inherited from LambdaServer.getRouter

Return current Router object

Returns Router
- Defined in packages/core/lib/core.d.ts:286

getSalt(): string

Inherited from LambdaServer.getSalt

Return a salt to use when doing digest

Returns string

Current salt
- Defined in packages/core/lib/core.d.ts:348

getSecret(): string

Inherited from LambdaServer.getSecret

This should return a "turning" secret with cache and a service to modify it every x mins WARNING The security is lower without this "turning" secret, you can still set the global.secret parameter

Dont rely on this method, it will probably disapear to avoid secret leak

deprecated

Returns string

Current secret
- Defined in packages/core/lib/core.d.ts:342

getServerStatus(): ServerStatus

Inherited from WebdaServer.getServerStatus

Get server status

Returns ServerStatus
- Defined in packages/shell/src/handlers/http.ts:289

getService<T>(name?: string): T

Inherited from LambdaServer.getService

Check for a service name and return the wanted singleton or undefined if none found

Type parameters
- T: Service
Parameters
- Optional name: string
  
  The service name to retrieve
Returns T
- Defined in packages/core/lib/core.d.ts:292

getServiceParams(service: string): any

Inherited from LambdaServer.getServiceParams

Parameters
- service: string
Returns any
- Defined in packages/core/lib/core.d.ts:371

getServices(): object

Inherited from LambdaServer.getServices

Return a map of defined services

Returns object
- [key: string]: Service
- Defined in packages/core/lib/core.d.ts:297

getServicesImplementations(type?: any): object

Inherited from LambdaServer.getServicesImplementations

Return a map of services that extends type

Parameters
- Optional type: any
  
  The type of implementation
Returns object
- [key: string]: Service
- Defined in packages/core/lib/core.d.ts:305

getStores(): object

Inherited from LambdaServer.getStores

Return a map of defined stores

Returns object
- [key: string]: Service
- Defined in packages/core/lib/core.d.ts:313

getVersion(): string

Inherited from LambdaServer.getVersion

Return webda current version

since

0.4.0

Returns string

package version
- Defined in packages/core/lib/core.d.ts:258

getWebdaApplication(): Application

Returns Application
- Defined in packages/shell/src/handlers/config.ts:109

getWorkerOutput(): WorkerOutput

Inherited from LambdaServer.getWorkerOutput

Get WorkerOutput

Returns WorkerOutput
- Defined in packages/core/lib/core.d.ts:227

handleRequest(req: any, res: any, next: any): Promise<any>

Inherited from WebdaServer.handleRequest

Manage the request

Parameters
- req: any
- res: any
- next: any
Returns Promise<any>
- Defined in packages/shell/src/handlers/http.ts:51

handleStaticIndexRequest(req: any, res: any, next: any): void

Inherited from WebdaServer.handleStaticIndexRequest

Parameters
- req: any
- res: any
- next: any
Returns void
- Defined in packages/shell/src/handlers/http.ts:180

init(): Promise<void>

Inherited from LambdaServer.init

Init Webda

It will resolve Services init method and autolink

Returns Promise<void>
- Defined in packages/core/lib/core.d.ts:233

initBeanRoutes(serviceBean: Service): void

Inherited from LambdaServer.initBeanRoutes

Init Routes declare by @Route annotation

Parameters
- serviceBean: Service
Returns void
- Defined in packages/core/lib/core.d.ts:391

initStatics(): void

Inherited from LambdaServer.initStatics

Returns void
- Defined in packages/core/lib/core.d.ts:387

isDebug(): boolean

Inherited from LambdaServer.isDebug

Return if Webda is in debug mode

Returns boolean
- Defined in packages/core/lib/core.d.ts:365

jsonFilter(key: string, value: any): any

Inherited from LambdaServer.jsonFilter

Parameters
- key: string
- value: any
Returns any
- Defined in packages/core/lib/core.d.ts:386

listenerCount(type: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

Overrides EventEmitter.listenerCount

Parameters
- type: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:46

listeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.listeners

Overrides EventEmitter.listeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:42

log(level: WorkerLogLevel, ...args: any[]): void

Inherited from LambdaServer.log

Logs

Parameters
- level: WorkerLogLevel
- Rest ...args: any[]
Returns void
- Defined in packages/core/lib/core.d.ts:418

logRequest(...args: any[]): void

Inherited from WebdaServer.logRequest

Parameters
- Rest ...args: any[]
Returns void
- Defined in packages/shell/src/handlers/http.ts:23

newContext<T>(httpContext: HttpContext, stream?: any, noInit?: boolean): Promise<T>

Inherited from LambdaServer.newContext

Create a new context for a request

Type parameters
- T: Context
Parameters
- httpContext: HttpContext
  
  THe HTTP request context
- Optional stream: any
  
  The request output stream if any
- Optional noInit: boolean
Returns Promise<T>

A new context object to pass along
- Defined in packages/core/lib/core.d.ts:400

off(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.off

Overrides EventEmitter.off

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:38
Returns this
- Defined in node_modules/@types/node/events.d.ts:38

on(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.on

Overrides EventEmitter.on

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:33
Returns this
- Defined in node_modules/@types/node/events.d.ts:33

once(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.once

Overrides EventEmitter.once

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:34
Returns this
- Defined in node_modules/@types/node/events.d.ts:34

output(...args: any[]): void

Inherited from WebdaServer.output

Parameters
- Rest ...args: any[]
Returns void
- Defined in packages/shell/src/handlers/http.ts:27

parameter(name: string): any

Inherited from LambdaServer.parameter

Retrieve a global parameter

Parameters
- name: string
Returns any
- Defined in packages/core/lib/core.d.ts:422

prependListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependListener

Overrides EventEmitter.prependListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:35
Returns this
- Defined in node_modules/@types/node/events.d.ts:35

prependOnceListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependOnceListener

Overrides EventEmitter.prependOnceListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:36
Returns this
- Defined in node_modules/@types/node/events.d.ts:36

rawListeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.rawListeners

Overrides EventEmitter.rawListeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:43

registerModel(name: string, clazz: any): void

Inherited from LambdaServer.registerModel

Register model

Parameters
- name: string
- clazz: any
Returns void
- Defined in packages/core/lib/core.d.ts:326

registerRequestFilter(filter: RequestFilter<Context>): void

Inherited from LambdaServer.registerRequestFilter

Parameters
- filter: RequestFilter<Context>
Returns void
- Defined in packages/core/lib/core.d.ts:234

reinit(updates: any): Promise<void>

Inherited from LambdaServer.reinit

Parameters
- updates: any
Returns Promise<void>
- Defined in packages/core/lib/core.d.ts:370

reinitResolvedRoutes(): void

Inherited from LambdaServer.reinitResolvedRoutes

Reinit the @Route

Returns void
- Defined in packages/core/lib/core.d.ts:209

removeAllListeners(event?: string | symbol): this

Inherited from CloudWatchLogger.removeAllListeners

Overrides EventEmitter.removeAllListeners

Parameters
- Optional event: string | symbol
Returns this
- Defined in node_modules/@types/node/events.d.ts:39

removeListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.removeListener

Overrides EventEmitter.removeListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:37
Returns this
- Defined in node_modules/@types/node/events.d.ts:37

removeRoute(url: string): void

Inherited from LambdaServer.removeRoute

Remove a route dynamicly

Parameters
- url: string
  
  to remove
Returns void
- Defined in packages/core/lib/core.d.ts:282

sandbox(executor: any, code: any): any

Inherited from LambdaServer.sandbox

Parameters
- executor: any
  
  The executor to expose as executor
- code: any
  
  to execute
Returns any
- Defined in packages/core/lib/core.d.ts:240

serve(): Promise<void>

Overrides WebdaServer.serve

Returns Promise<void>
- Defined in packages/shell/src/handlers/config.ts:113

serveIndex(express: any, app: any): void

Inherited from WebdaServer.serveIndex

Serve a static index if page not found, usefull for Single Page Application

Parameters
- express: any
- app: any
Returns void
- Defined in packages/shell/src/handlers/http.ts:202

serveStaticWebsite(express: any, app: any): void

Inherited from WebdaServer.serveStaticWebsite

Serve a static directory

Parameters
- express: any
- app: any
Returns void
- Defined in packages/shell/src/handlers/http.ts:190

setDevMode(devMode: boolean): void

Inherited from WebdaServer.setDevMode

Parameters
- devMode: boolean
Returns void
- Defined in packages/shell/src/handlers/http.ts:19

setMaxListeners(n: number): this

Inherited from CloudWatchLogger.setMaxListeners

Overrides EventEmitter.setMaxListeners

Parameters
- n: number
Returns this
- Defined in node_modules/@types/node/events.d.ts:40

stop(): Promise<void>

Inherited from WebdaServer.stop

Stop the http server

Returns Promise<void>
- Defined in packages/shell/src/handlers/http.ts:316

toPublicJSON(object: any): string

Inherited from LambdaServer.toPublicJSON

Convert an object to JSON using the Webda json filter

Parameters
- object: any
  
  The object to export
Returns string

The export of the strip object ( removed all attribute with _ )
- Defined in packages/core/lib/core.d.ts:408

updateContextWithRoute(ctx: Context): boolean

Inherited from LambdaServer.updateContextWithRoute

Add to context information and executor based on the http context

Parameters
- ctx: Context
Returns boolean
- Defined in packages/core/lib/core.d.ts:352

validate(object: any, schema: any): any

Inherited from LambdaServer.validate

Validate the object with schema

Parameters
- object: any
  
  to validate
- schema: any
  
  path to use
Returns any
- Defined in packages/core/lib/core.d.ts:247

validationLastErrors(): any

Inherited from LambdaServer.validationLastErrors

Get last errors from AJV schema validator ( called through validate method )

Returns any
- Defined in packages/core/lib/core.d.ts:251

waitForStatus(status: Stopped | Started, timeout?: number): Promise<void>

Inherited from WebdaServer.waitForStatus

Wait for the server to be in a desired state

Parameters
- status: Stopped | Started
  
  to wait for
- Default value timeout: number = 60000
  
  max number of ms to wait for
Returns Promise<void>
- Defined in packages/shell/src/handlers/http.ts:299

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:29

Generated using TypeDoc