Class Context

Hierarchy

EventEmitter
- Context

Properties

Methods

addAsyncRequest

cookie

emit

emitError

end

execute

getCurrentUserId

getLocale

getMaxListeners

getPathParameters

getRequestParameters

getResponseBody

getResponseCookies

getResponseHeaders

getRoute

getServiceParameters

getStream

getWebda

init

isEnded

isGlobal

json

listeners

log

off

on

once

parameter

prependListener

prependOnceListener

redirect

reinit

removeAllListeners

setHeader

setMaxListeners

setPathParameters

setServiceParameters

status

write

writeHead

getGlobalContext

setGlobalContext

Properties

_body: any

_buffered: boolean

_cookie: Map<string, Cookie>

_ended: Promise<any> = undefined

_executor: Service<any>

_flushHeaders: boolean

_http: HttpContext

_outputHeaders: Map<string, string>

_pathParams: any

_promises: Promise<any>[]

_route: any

_sanitized: any

_serviceParams: any

_stream: any

_webda: Core

clientInfo: ClientInfo

files: any[]

headers: Map<string, string>

parameters: any = undefined

session: SessionCookie

statusCode: number

__globalContext: Context

defaultMaxListeners: number

Methods

addAsyncRequest(promise: any): void

Parameters
- promise: any
Returns void
- Defined in packages/core/src/utils/context.ts:378

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

cookie(param: any, value: any, options?: any): void

For compatibility reason

todo

Implement the serialization Not yet handle by the Webda framework

Parameters
- param: any
- value: any
- Default value options: any = undefined
Returns void
- Defined in packages/core/src/utils/context.ts:366

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

emitError(err: any): void

Parameters
- err: any
Returns void
- Defined in packages/core/src/utils/context.ts:648

end(): Promise<any>

Flush the request

emits

'finish' event

throws

Error if the request was already ended

Returns Promise<any>
- Defined in packages/core/src/utils/context.ts:416

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

execute(): Promise<unknown>

Execute the target route

Returns Promise<unknown>
- Defined in packages/core/src/utils/context.ts:542

getCurrentUser<T>(): Promise<T>

Get the current user from session

Type parameters
- T: User
Returns Promise<T>
- Defined in packages/core/src/utils/context.ts:515

getCurrentUserId(): string

Get the current user id from session

Returns string
- Defined in packages/core/src/utils/context.ts:525

getExecutor(): Service<any>

Return the service handling the request

Returns Service<any>
- Defined in packages/core/src/utils/context.ts:535

getHttpContext(): HttpContext

Get current http context

Returns HttpContext
- Defined in packages/core/src/utils/context.ts:245

getLocale(): string

Get the request locale if found

Returns string
- Defined in packages/core/src/utils/context.ts:561

getMaxListeners(): number

Inherited from CloudWatchLogger.getMaxListeners

Overrides EventEmitter.getMaxListeners

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

getParameters(): any

Returns any
- Defined in packages/core/src/utils/context.ts:264

getPathParameters(): any

Returns any
- Defined in packages/core/src/utils/context.ts:284

getRequest(): IncomingMessage

Returns IncomingMessage
- Defined in packages/core/src/utils/context.ts:472

getRequestBody(sanitizedOptions?: any): any

Parameters
- Default value sanitizedOptions: any = {allowedTags: [],allowedAttributes: {}}
Returns any
- Defined in packages/core/src/utils/context.ts:441

getRequestParameters(): any

Returns any
- Defined in packages/core/src/utils/context.ts:256

getResponseBody(): any

Returns any
- Defined in packages/core/src/utils/context.ts:468

getResponseCookies(): Map<string, Cookie>

Returns Map<string, Cookie>
- Defined in packages/core/src/utils/context.ts:374

getResponseHeaders(): any

Get output headers

Returns any
- Defined in packages/core/src/utils/context.ts:252

getRoute(): any

Returns any
- Defined in packages/core/src/utils/context.ts:580

getService<T>(name: any): T

Get a service from webda

see

Webda

Type parameters
- T: Service
Parameters
- name: any
  
  of the service
Returns T
- Defined in packages/core/src/utils/context.ts:500

getServiceParameters(): any

Returns any
- Defined in packages/core/src/utils/context.ts:280

getSession(): SessionCookie

Returns SessionCookie
- Defined in packages/core/src/utils/context.ts:273

getStream(): any

Get the HTTP stream to output raw data

Returns any
- Defined in packages/core/src/utils/context.ts:508

getWebda(): Core

Return the webda

Returns Core
- Defined in packages/core/src/utils/context.ts:554

init(): Promise<void>

Returns Promise<void>
- Defined in packages/core/src/utils/context.ts:639

isEnded(): Promise<any>

Returns Promise<any>
- Defined in packages/core/src/utils/context.ts:382

isGlobal(): boolean

Returns boolean
- Defined in packages/core/src/utils/context.ts:213

json(obj: any): this

Express response allow answer to be sent this w

Parameters
- obj: any
Returns this
- Defined in packages/core/src/utils/context.ts:405

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

Proxy for simplification

Parameters
- level: WorkerLogLevel
- Rest ...args: any[]
Returns void
- Defined in packages/core/src/utils/context.ts:601

newSession(): SessionCookie

Returns SessionCookie
- Defined in packages/core/src/utils/context.ts:634

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

parameter(name: string): any

Parameters
- name: string
Returns any
- Defined in packages/core/src/utils/context.ts:260

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

redirect(url: string): void

Redirect to another url

Parameters
- url: string
Returns void
- Defined in packages/core/src/utils/context.ts:357

reinit(): void

Returns void
- Defined in packages/core/src/utils/context.ts:238

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

resetResponse(): void

Returns void
- Defined in packages/core/src/utils/context.ts:298

setExecutor(executor: any): void

Parameters
- executor: any
  
  Set the current executor for this context
Returns void
- Defined in packages/core/src/utils/context.ts:586

setHeader(header: any, value: any): void

Set a header value

Parameters
- header: any
  
  name
- value: any
Returns void
- Defined in packages/core/src/utils/context.ts:334

setHttpContext(httpContext: HttpContext): void

Set current http context

Parameters
- httpContext: HttpContext
  
  current http context
Returns void
- Defined in packages/core/src/utils/context.ts:233

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

setPathParameters(params: any): void

Parameters
- params: any
Returns void
- Defined in packages/core/src/utils/context.ts:293

setServiceParameters(params: any): void

Parameters
- params: any
Returns void
- Defined in packages/core/src/utils/context.ts:288

status(code: number): this

Express response allow statusCode to be defined this was

Parameters
- code: number
  
  to return
Returns this
- Defined in packages/core/src/utils/context.ts:396

write(output: any, encoding?: string, cb?: function): boolean

Write data to the client

Parameters
- output: any
  
  If it is an object it will be serializeb with toPublicJSON, if it is a String it will be appended to the result, if it is a buffer it will replace the result
- Optional encoding: string
- Optional cb: function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
      Defined in packages/core/src/utils/context.ts:309
Returns boolean
- Defined in packages/core/src/utils/context.ts:309

writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this

Write the http return code and some headers Those headers are not flushed yet so can still be overwritten

Parameters
- statusCode: number
  
  to return to the client
- Default value headers: OutgoingHttpHeaders = undefined
  
  to add to the response
Returns this
- Defined in packages/core/src/utils/context.ts:345

getGlobalContext(): Context

Get Global Context

Returns Context
- Defined in packages/core/src/utils/context.ts:199

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

setGlobalContext(ctx: Context): void

Set the Global Context

Parameters
- ctx: Context
  
  to set as Global
Returns void
- Defined in packages/core/src/utils/context.ts:208

Generated using TypeDoc