Skip to main content

@webda/coreReadme | API


Class: GlobalContext

OperationContext is used when call to an operation

Extends

Constructors

new GlobalContext(webda)

new GlobalContext(webda): GlobalContext

Parameters

webda: Core<CoreEvents>

Returns

GlobalContext

Overrides

OperationContext.constructor

Source

packages/core/src/utils/context.ts:394

Properties

_body

protected _body: string

Output

Inherited from

OperationContext._body

Source

packages/core/src/utils/context.ts:87


_promises

_promises: Promise<any>[]

Contain all registered promises to this context

Inherited from

OperationContext._promises

Source

packages/core/src/utils/context.ts:98


_sanitized

protected _sanitized: any

Contain the sanitized request body if computed

Inherited from

OperationContext._sanitized

Source

packages/core/src/utils/context.ts:82


_stream

_stream: Writable

Output stream

Inherited from

OperationContext._stream

Source

packages/core/src/utils/context.ts:120


_webda

protected _webda: Core<CoreEvents>

Contain emitting Core

Inherited from

OperationContext._webda

Source

packages/core/src/utils/context.ts:70


extensions

protected extensions: Object

Allow extensions

Index signature

[key: string]: any

Inherited from

OperationContext.extensions

Source

packages/core/src/utils/context.ts:78


session

session: Session

Session

Overrides

OperationContext.session

Source

packages/core/src/utils/context.ts:392


__globalContext

static protected __globalContext: OperationContext<any, any>

Inherited from

OperationContext.__globalContext

Source

packages/core/src/utils/context.ts:65


captureRejectionSymbol

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

OperationContext.captureRejectionSymbol

Source

packages/core/node_modules/@types/node/events.d.ts:328


captureRejections

static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

OperationContext.captureRejections

Source

packages/core/node_modules/@types/node/events.d.ts:333


defaultMaxListeners

static defaultMaxListeners: number

Inherited from

OperationContext.defaultMaxListeners

Source

packages/core/node_modules/@types/node/events.d.ts:334


errorMonitor

static readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

OperationContext.errorMonitor

Source

packages/core/node_modules/@types/node/events.d.ts:327

Methods

addAsyncRequest()

addAsyncRequest(promise): void

Register a promise with the context

Parameters

promise: any

Returns

void

Inherited from

OperationContext.addAsyncRequest

Source

packages/core/src/utils/context.ts:167


addListener()

addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Parameters

eventName: string | symbol

listener: (...args) => void

Returns

this

Inherited from

OperationContext.addListener

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:354


createStream()

createStream(): void

Create a buffer stream

Returns

void

Inherited from

OperationContext.createStream

Source

packages/core/src/utils/context.ts:296


emit()

emit(eventName, ...args): boolean

Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

const EventEmitter = require('events');
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Parameters

eventName: string | symbol

• ...args: any[]

Returns

boolean

Inherited from

OperationContext.emit

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:610


end()

end(): Promise<void>

Ensure the whole execution is finished

Returns

Promise<void>

Inherited from

OperationContext.end

Source

packages/core/src/utils/context.ts:192


eventNames()

eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Inherited from

OperationContext.eventNames

Since

v6.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:669


getCurrentUser()

getCurrentUser<K>(refresh): Promise<K>

Get the current user from session

Type parameters

K extends User

Parameters

refresh: boolean= false

Returns

Promise<K>

Inherited from

OperationContext.getCurrentUser

Source

packages/core/src/utils/context.ts:361


getCurrentUserId()

getCurrentUserId(): any

Get the current user id from session

Returns

any

Inherited from

OperationContext.getCurrentUserId

Source

packages/core/src/utils/context.ts:375


getExtension()

getExtension<K>(name): K

Get an extension of the context

Type parameters

K = any

Parameters

name: string

of the extension

Returns

K

extension object

Inherited from

OperationContext.getExtension

Source

packages/core/src/utils/context.ts:126


getHttpContext()

getHttpContext(): HttpContext

Get current http context

Returns

HttpContext

Inherited from

OperationContext.getHttpContext

Source

packages/core/src/utils/context.ts:185


getInput()

getInput(sanitizedOptions): Promise<any>

Parameters

sanitizedOptions: IOptions & Object= undefined

Returns

Promise<any>

Inherited from

OperationContext.getInput

Source

packages/core/src/utils/context.ts:198


getMaxListeners()

getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Returns

number

Inherited from

OperationContext.getMaxListeners

Since

v1.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:526


getOutput()

getOutput(): string

Get output as string, if a OutputStream is provided it will returned null

Returns

string

Inherited from

OperationContext.getOutput

Source

packages/core/src/utils/context.ts:175


getOutputStream()

getOutputStream(): Writable

Get the HTTP stream to output raw data

Returns

Writable

Inherited from

OperationContext.getOutputStream

Source

packages/core/src/utils/context.ts:271


getRawInput()

getRawInput(_limit, _timeout): Promise<Buffer>

Parameters

_limit: number= undefined

_timeout: number= 60000

Returns

Promise<Buffer>

Inherited from

OperationContext.getRawInput

Source

packages/core/src/utils/context.ts:256


getRawInputAsString()

getRawInputAsString(limit, timeout, encoding?): Promise<string>

By default empty

Parameters

limit: number= undefined

timeout: number= 60000

encoding?: BufferEncoding

Returns

Promise<string>

Inherited from

OperationContext.getRawInputAsString

Source

packages/core/src/utils/context.ts:245


getRawStream()

getRawStream(): Readable

Returns

Readable

Inherited from

OperationContext.getRawStream

Source

packages/core/src/utils/context.ts:263


getSession()

getSession<K>(): K

Get linked session

Type parameters

K = Session

Returns

K

Inherited from

OperationContext.getSession

Source

packages/core/src/utils/context.ts:279


getWebda()

getWebda(): Core<CoreEvents>

Return the webda

Returns

Core<CoreEvents>

Inherited from

OperationContext.getWebda

Source

packages/core/src/utils/context.ts:159


init()

init(): Promise<GlobalContext>

Returns

Promise<GlobalContext>

Inherited from

OperationContext.init

Source

packages/core/src/utils/context.ts:354


isGlobal()

isGlobal(): boolean

Returns

boolean

Overrides

OperationContext.isGlobal

Source

packages/core/src/utils/context.ts:404


listenerCount()

listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Parameters

eventName: string | symbol

The name of the event being listened for

Returns

number

Inherited from

OperationContext.listenerCount

Since

v3.2.0

Source

packages/core/node_modules/@types/node/events.d.ts:616


listeners()

listeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Parameters

eventName: string | symbol

Returns

Function[]

Inherited from

OperationContext.listeners

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:539


log()

log(level, ...args): void

Proxy for simplification

Parameters

level: WorkerLogLevel

• ...args: any[]

Returns

void

Inherited from

OperationContext.log

Source

packages/core/src/utils/context.ts:308


newSession()

newSession(): Promise<Session>

Create a new session

Returns

Promise<Session>

Inherited from

OperationContext.newSession

Source

packages/core/src/utils/context.ts:316


off()

off(eventName, listener): this

Alias for emitter.removeListener().

Parameters

eventName: string | symbol

listener: (...args) => void

Returns

this

Inherited from

OperationContext.off

Since

v10.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:499


on()

on(eventName, listener): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a

Parameters

eventName: string | symbol

The name of the event.

listener: (...args) => void

The callback function

Returns

this

Inherited from

OperationContext.on

Since

v0.1.101

Source

packages/core/node_modules/@types/node/events.d.ts:385


once()

once(eventName, listener): this

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a

Parameters

eventName: string | symbol

The name of the event.

listener: (...args) => void

The callback function

Returns

this

Inherited from

OperationContext.once

Since

v0.3.0

Source

packages/core/node_modules/@types/node/events.d.ts:414


prependListener()

prependListener(eventName, listener): this

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

eventName: string | symbol

The name of the event.

listener: (...args) => void

The callback function

Returns

this

Inherited from

OperationContext.prependListener

Since

v6.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:634


prependOnceListener()

prependOnceListener(eventName, listener): this

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

eventName: string | symbol

The name of the event.

listener: (...args) => void

The callback function

Returns

this

Inherited from

OperationContext.prependOnceListener

Since

v6.0.0

Source

packages/core/node_modules/@types/node/events.d.ts:650


rawListeners()

rawListeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Parameters

eventName: string | symbol

Returns

Function[]

Inherited from

OperationContext.rawListeners

Since

v9.4.0

Source

packages/core/node_modules/@types/node/events.d.ts:569


reinit()

reinit(): void

Remove sanitized body

Returns

void

Inherited from

OperationContext.reinit

Source

packages/core/src/utils/context.ts:286


removeAllListeners()

removeAllListeners(event?): this

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

event?: string | symbol

Returns

this

Inherited from

OperationContext.removeAllListeners

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:510


removeListener()

removeListener(eventName, listener): this

Removes the specified listener from the listener array for the event namedeventName.

const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

const myEmitter = new MyEmitter();

const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

const ee = new EventEmitter();

function pong() {
console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

eventName: string | symbol

listener: (...args) => void

Returns

this

Inherited from

OperationContext.removeListener

Since

v0.1.26

Source

packages/core/node_modules/@types/node/events.d.ts:494


resetResponse()

resetResponse(): void

Remove everything that was about to be sent

Returns

void

Inherited from

OperationContext.resetResponse

Source

packages/core/src/utils/context.ts:324


setExtension()

setExtension(name, extension): this

Parameters

name: string

to add

extension: any

object to store

Returns

this

Inherited from

OperationContext.setExtension

Source

packages/core/src/utils/context.ts:151


setHeader()

setHeader(_name, _value): void

For easier compatibility with WebContext On OperationContext this call is simply ignored

Parameters

_name: string

_value: string

Returns

void

Inherited from

OperationContext.setHeader

Source

packages/core/src/utils/context.ts:134


setMaxListeners()

setMaxListeners(n): this

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

n: number

Returns

this

Inherited from

OperationContext.setMaxListeners

Since

v0.3.5

Source

packages/core/node_modules/@types/node/events.d.ts:520


write()

write(output, _encoding?, _cb?): boolean

Write data to the client

Parameters

output: any

If it is an object it will be serialized with toPublicJSON, if it is a String it will be appended to the result, if it is a buffer it will replace the result

_encoding?: string

_cb?: (error) => void

Returns

boolean

Inherited from

OperationContext.write

Source

packages/core/src/utils/context.ts:337


writeHead()

writeHead(_code, _headers): void

For easier compatibility with WebContext On OperationContext this call is simply ignored

Parameters

_code: number

_headers: any

Returns

void

Inherited from

OperationContext.writeHead

Source

packages/core/src/utils/context.ts:142


getEventListeners()

static getEventListeners(emitter, name): Function[]

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

const { getEventListeners, EventEmitter } = require('events');

{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
getEventListeners(ee, 'foo'); // [listener]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
getEventListeners(et, 'foo'); // [listener]
}

Parameters

emitter: EventEmitter | _DOMEventTarget

name: string | symbol

Returns

Function[]

Inherited from

OperationContext.getEventListeners

Since

v15.2.0, v14.17.0

Source

packages/core/node_modules/@types/node/events.d.ts:299


listenerCount()

static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Parameters

emitter: EventEmitter

The emitter to query

eventName: string | symbol

The event name

Returns

number

Inherited from

OperationContext.listenerCount

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Source

packages/core/node_modules/@types/node/events.d.ts:271


on()

static on(emitter, eventName, options?): AsyncIterableIterator<any>

const { on, EventEmitter } = require('events');

(async () => {
const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

const { on, EventEmitter } = require('events');
const ac = new AbortController();

(async () => {
const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();

process.nextTick(() => ac.abort());

Parameters

emitter: EventEmitter

eventName: string

The name of the event being listened for

options?: StaticEventEmitterOptions

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Inherited from

OperationContext.on

Since

v13.6.0, v12.16.0

Source

packages/core/node_modules/@types/node/events.d.ts:254


once()

once(emitter, eventName, options)

static once(emitter, eventName, options?): Promise<any[]>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
const ee = new EventEmitter();

process.nextTick(() => {
ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});

try {
await once(ee, 'myevent');
} catch (err) {
console.log('error happened', err);
}
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
Parameters

emitter: _NodeEventTarget

eventName: string | symbol

options?: StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

OperationContext.once

Since

v11.13.0, v10.16.0

Source

packages/core/node_modules/@types/node/events.d.ts:194

once(emitter, eventName, options)

static once(emitter, eventName, options?): Promise<any[]>

Parameters

emitter: _DOMEventTarget

eventName: string

options?: StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

OperationContext.once

Source

packages/core/node_modules/@types/node/events.d.ts:195


setMaxListeners()

static setMaxListeners(n?, ...eventTargets?): void

const {
setMaxListeners,
EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

n?: number

A non-negative number. The maximum number of listeners per EventTarget event.

• ...eventTargets?: (EventEmitter | _DOMEventTarget)[]

Returns

void

Inherited from

OperationContext.setMaxListeners

Since

v15.4.0

Source

packages/core/node_modules/@types/node/events.d.ts:317