@webda/core • Readme | API

Class: `abstract` Store<T, K, E>

This class handle NoSQL storage and mapping (duplication) between NoSQL object TODO Create the mapping documentation

It use basic CRUD, and can expose those 4 to through HTTP

It emits events : Store.Save: Before saving the object Store.Saved: After saving the object Store.Update: Before updating the object Store.Updated: After updating the object Store.Delete: Before deleting the object Store.Deleted: After deleting the object Store.Get: When getting the object Store.Action: When an action will be done on an object Store.Actioned: When an action has been done on an object

Mapping:

Parameters

map: { ... } expose: { // Enable the HTTP exposure url: '', // The url to expose to by default it is service name in lowercase ( users for example ) restrict: { create: true, // Don't expose the POST /users update: true, // Don't expose the PUT /users/{uuid} delete: true, // Don't expose the DELETE /users/{uuid} get: true // Don't expose the GET /users/{uuid} } }

Extends

Service<K, E>

Type parameters

• T extends CoreModel = CoreModel

• K extends StoreParameters = StoreParameters

• E extends StoreEvents = StoreEvents

Implements

ConfigurationProvider
MappingService<T>

Constructors

new Store(webda, name, params)

new Store<T, K, E>(webda, name, params): Store<T, K, E>

Parameters

• webda: Core<CoreEvents>

The main instance of Webda

• name: string

The name of the service

• params: DeepPartial<K>= {}

The parameters block define in the configuration file

Returns

Store<T, K, E>

Inherited from

Service.constructor

Source

packages/core/src/services/service.ts:334

Properties

_cacheStore

_cacheStore: Store<T, StoreParameters, StoreEvents>

Cache store

Source

packages/core/src/stores/store.ts:567

_createException

_createException: string

Inherited from

Service._createException

Source

packages/core/src/services/service.ts:315

_initException

_initException: any = undefined

Inherited from

Service._initException

Source

packages/core/src/services/service.ts:317

_initTime

_initTime: number

Inherited from

Service._initTime

Source

packages/core/src/services/service.ts:316

_model

_model: CoreModelDefinition<T>

Contains the current model

Source

packages/core/src/stores/store.ts:575

_modelType

_modelType: string

Contains the current model type

Source

packages/core/src/stores/store.ts:583

_modelsHierarchy

_modelsHierarchy: Object = {}

Store teh manager hierarchy with their depth

Index signature

[key: string]: number

Source

packages/core/src/stores/store.ts:579

_name

protected _name: string

Service name

Inherited from

Service._name

Source

packages/core/src/services/service.ts:308

_reverseMap

_reverseMap: Object[] = []

Contain the reverse map

Source

packages/core/src/stores/store.ts:571

_uuidField

protected _uuidField: string = "uuid"

Contain the model uuid field

Source

packages/core/src/stores/store.ts:587

_webda

protected _webda: Core<CoreEvents>

Webda Core object

Inherited from

Service._webda

Source

packages/core/src/services/service.ts:304

logger

protected logger: Logger

Logger with class context

Inherited from

Service.logger

Source

packages/core/src/services/service.ts:321

metrics

metrics: Object

Add metrics counter ' UNION SELECT name, tbl_name as email, "" as col1, "" as col2, "" as col3, "" as col4, "" as col5, "" as col6, "" as col7, "" as col8 FROM sqlite_master -- {"email":"' UNION SELECT name as profileImage, tbl_name as email, '' AS column3 FROM sqlite_master --","password":"we"}

Type declaration

cache_hits

cache_hits: Counter<string>

cache_invalidations

cache_invalidations: Counter<string>

operations_total

operations_total: Counter<string>

queries

queries: Histogram<string>

slow_queries_total

slow_queries_total: Counter<string>

Overrides

Service.metrics

Source

packages/core/src/stores/store.ts:593

parameters

protected parameters: K

Hold the parameters for your service

It will be bring from the webda.config.json

Inherited from

Service.parameters

Source

packages/core/src/services/service.ts:314

captureRejectionSymbol

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

Service.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

Service.captureRejections

Source

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

defaultMaxListeners

static defaultMaxListeners: number

Inherited from

Service.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

Service.errorMonitor

Source

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

Methods

__clean()

__clean(): Promise<void>

Clean the service data, can only be used in test mode

Returns

Promise<void>

Inherited from

Service.__clean

Abstract

Source

packages/core/src/services/service.ts:642

_delete()

protected abstract _delete(uid, writeCondition?, itemWriteConditionField?): Promise<void>

The underlying store should recheck writeCondition only if it does not require another get()

Parameters

• uid: string

• writeCondition?: any

• itemWriteConditionField?: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2492

_deleteItemFromCollection()

protected abstract _deleteItemFromCollection(uid, prop, index, itemWriteCondition, itemWriteConditionField, updateDate): Promise<any>

Parameters

• uid: string

• prop: string

• index: number

• itemWriteCondition: any

• itemWriteConditionField: string

• updateDate: Date

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:2560

_exists()

abstract _exists(uid): Promise<boolean>

Check if an object exists

Parameters

• uid: string

Returns

Promise<boolean>

Abstract

Source

packages/core/src/stores/store.ts:2482

_get()

protected abstract _get(uid, raiseIfNotFound?): Promise<T>

Retrieve an element from the store

Parameters

• uid: string

to retrieve

• raiseIfNotFound?: boolean

raise an StoreNotFound exception if not found

Returns

Promise<T>

Source

packages/core/src/stores/store.ts:2500

_getFromCache()

_getFromCache(uuid, raiseIfNotFound): Promise<T>

Get From Cache or main

Parameters

• uuid: string

• raiseIfNotFound: boolean= false

Returns

Promise<T>

Source

packages/core/src/stores/store.ts:728

_incrementAttributes()

protected abstract _incrementAttributes(uid, params, updateDate): Promise<any>

Increment the attribute

Parameters

• uid: string

• params: Object[]

• updateDate: Date

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:2544

_patch()

protected abstract _patch(object, uid, itemWriteCondition?, itemWriteConditionField?): Promise<any>

Parameters

• object: any

• uid: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:2517

_removeAttribute()

protected abstract _removeAttribute(uuid, attribute, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Parameters

• uuid: string

• attribute: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2524

_save()

protected abstract _save(object): Promise<any>

Save within the store

Parameters

• object: T

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:2535

_update()

protected abstract _update(object, uid, itemWriteCondition?, itemWriteConditionField?): Promise<any>

Parameters

• object: any

• uid: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:2510

_upsertItemToCollection()

protected abstract _upsertItemToCollection(uid, prop, item, index, itemWriteCondition, itemWriteConditionField, updateDate): Promise<any>

Parameters

• uid: string

• prop: string

• item: any

• index: number

• itemWriteCondition: any

• itemWriteConditionField: string

• updateDate: Date

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:2550

addListener()

addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.addListener

Since

v0.1.26

Source

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

addReverseMap()

addReverseMap(prop, store): void

Add reverse map information

Parameters

• prop: string

• store: MappingService<any>

Returns

void

Source

packages/core/src/stores/store.ts:983

addRoute()

protected addRoute(url, methods, executer, openapi, override): void

Add a route dynamicaly

Parameters

• url: string

of the route can contains dynamic part like {uuid}

• methods: HttpMethodType[]

• executer: Function

Method to execute for this route

• openapi: OpenAPIWebdaDefinition= {}

• override: boolean= false

Returns

void

Inherited from

Service.addRoute

Source

packages/core/src/services/service.ts:482

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Authorize a public event subscription

Parameters

• _event: string

• _context: OperationContext<any, any>

Returns

boolean

Inherited from

Service.authorizeClientEvent

Source

packages/core/src/services/service.ts:438

cacheStorePatchException()

cacheStorePatchException(): void

We should ignore exception from the store

Returns

void

Source

packages/core/src/stores/store.ts:891

canTriggerConfiguration()

canTriggerConfiguration(_id, _callback): boolean

By default we cannot know if the store will trigger or not

Parameters

• _id: string

• _callback: () => void

Returns

boolean

Implementation of

ConfigurationProvider.canTriggerConfiguration

Source

packages/core/src/stores/store.ts:1949

cancelMigration()

cancelMigration(name): Promise<void>

Delete a migration

Parameters

• name: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1755

cascadeDelete()

cascadeDelete(obj, _uuid): Promise<any>

Cascade delete a related object

Parameters

• obj: CoreModel

• _uuid: string

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:1845

checkCollectionUpdateCondition()

checkCollectionUpdateCondition<FK, CK>(model, collection, conditionField?, condition?, index?): void

Check if an UpdateCondition is met

Type parameters

• FK extends string | number | symbol

• CK extends string | number | symbol

Parameters

• model: T

• collection: FK

• conditionField?: CK

• condition?: any

• index?: number

Returns

void

Source

packages/core/src/stores/store.ts:1464

checkUpdateCondition()

checkUpdateCondition<CK>(model, conditionField?, condition?, uid?): void

Check if an UpdateCondition is met

Type parameters

• CK extends string | number | symbol

Parameters

• model: T

• conditionField?: CK

• condition?: any

• uid?: string

Returns

void

Source

packages/core/src/stores/store.ts:1448

cleanModelAliases()

cleanModelAliases(): Promise<void>

Ensure model aliases are not used in this store

So alias can be cleaned

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1686

computeParameters()

computeParameters(): void

Retrieve the Model

Returns

void

Overrides

Service.computeParameters

Throws

Error if model is not found

Source

packages/core/src/stores/store.ts:611

conditionalPatch()

conditionalPatch<CK>(uuid, updates, conditionField, condition): Promise<boolean>

Update conditionally

Type parameters

• CK extends string | number | symbol

Parameters

• uuid: string

• updates: Partial<T>

• conditionField: CK

• condition: any

Returns

Promise<boolean>

Source

packages/core/src/stores/store.ts:1493

create()

create(object, ctx): Promise<any>

Parameters

• object: any

• ctx: OperationContext<any, any>= undefined

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:1378

delete()

delete<CK>(uid, writeCondition?, writeConditionField?, sync?): Promise<void>

Delete an object

Type parameters

• CK extends string | number | symbol

Parameters

• uid: string | T

• writeCondition?: any

• writeConditionField?: CK

• sync?: boolean= false

Returns

Promise<void>

the deletion promise

Source

packages/core/src/stores/store.ts:1866

deleteItemFromCollection()

deleteItemFromCollection<FK>(uid, prop, index, itemWriteCondition, itemWriteConditionField): Promise<Date>

Remove an item from an array in the model

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

of the model

• prop: FK

of the model to remove from

• index: number

of the item to remove in the array

• itemWriteCondition: any

value of the condition

• itemWriteConditionField: string= undefined

field to read the condition from

Returns

Promise<Date>

Source

packages/core/src/stores/store.ts:1086

emit()

emit<Key>(event, data): boolean

Override to allow capturing long listeners

Type parameters

• Key extends string | number | symbol

Parameters

• event: symbol | Key

• data: E[Key]

Returns

boolean

Inherited from

Service.emit

Source

packages/core/src/services/service.ts:596

emitStoreEvent()

emitStoreEvent<Key>(event, data): Promise<void>

Handle StoreEvent and update cache based on it Then emit the event, it allows the cache to be updated before listeners are called

Type parameters

• Key extends keyof StoreEvents

Parameters

• event: Key

• data: E[Key] & Object

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1301

emitSync()

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

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

Type parameters

• Key extends string | number | symbol

Parameters

• event: Key

• data: E[Key]

Returns

Promise<any[]>

Inherited from

Service.emitSync

Source

packages/core/src/services/service.ts:588

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

Service.eventNames

Since

v6.0.0

Source

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

exists()

exists(uid): Promise<boolean>

Check if an object exists

Parameters

• uid: string | CoreModel

Returns

Promise<boolean>

Abstract

Params

uuid of the object or the object

Source

packages/core/src/stores/store.ts:2466

find()

abstract find(query): Promise<StoreFindResult<T>>

Search within the store

Parameters

• query: Query

Returns

Promise<StoreFindResult<T>>

Source

packages/core/src/stores/store.ts:2476

forceDelete()

forceDelete(uid): Promise<void>

Delete an object from the store without condition nor async

Parameters

• uid: string

to delete

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1855

get()

get(uid, ctx, defaultValue): Promise<T>

Get an object

Parameters

• uid: string

• ctx: OperationContext<any, any>= undefined

• defaultValue: any= undefined

Returns

Promise<T>

the object retrieved ( can be undefined if not found )

Source

packages/core/src/stores/store.ts:1992

getAll()

abstract getAll(list?): Promise<T[]>

Get an object

Parameters

• list?: string[]

Returns

Promise<T[]>

the objects retrieved ( can be [] if not found )

Source

packages/core/src/stores/store.ts:2508

getClientEvents()

getClientEvents(): string[]

Return the events that an external system can subscribe to

Returns

string[]

Inherited from

Service.getClientEvents

Source

packages/core/src/services/service.ts:429

getConfiguration()

getConfiguration(id): Promise<Object>

Provide a way to store configuration in store

Parameters

• id: string

Returns

Promise<Object>

Implementation of

ConfigurationProvider.getConfiguration

Source

packages/core/src/stores/store.ts:1958

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

Service.getMaxListeners

Since

v1.0.0

Source

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

getMetric()

getMetric<T>(type, configuration): T

Add service name label

Type parameters

• T = Counter<string> | Histogram<string> | Gauge<string>

Parameters

• type: Constructor<T, [MetricConfiguration<T>]>

• configuration: MetricConfiguration<T>

Returns

T

Inherited from

Service.getMetric

Source

packages/core/src/services/service.ts:414

getMigration()

getMigration(name): Promise<any>

Get a migration

Parameters

• name: string

Returns

Promise<any>

Source

packages/core/src/stores/store.ts:1763

getModel()

getModel(): CoreModelDefinition<CoreModel>

Return Store current model

Returns

CoreModelDefinition<CoreModel>

Source

packages/core/src/stores/store.ts:707

getName()

getName(): string

Get service name

Returns

string

Inherited from

Service.getName

Source

packages/core/src/services/service.ts:633

getObject()

getObject(uid): Promise<T>

Get object from store

Parameters

• uid: string

Returns

Promise<T>

Source

packages/core/src/stores/store.ts:747

getOpenApiReplacements()

getOpenApiReplacements(): Object

Return variables for replacement in openapi

Returns

Object

modelName

modelName: string

Overrides

Service.getOpenApiReplacements

Source

packages/core/src/stores/store.ts:2099

getOperationId()

getOperationId(id): string

If undefined is returned it cancel the operation registration

Parameters

• id: string

Returns

string

Inherited from

Service.getOperationId

Source

packages/core/src/services/service.ts:471

getParameters()

getParameters(): K

Get the service parameters

Returns

K

Inherited from

Service.getParameters

Source

packages/core/src/services/service.ts:359

getService()

getService<K>(service): K

Return a webda service

Type parameters

• K extends Service<ServiceParameters, Events>

Parameters

• service: string

name to retrieve

Returns

K

Inherited from

Service.getService

Source

packages/core/src/services/service.ts:626

getUrl()

getUrl(url, methods): string

Parameters

• url: string

• methods: HttpMethodType[]

Returns

string

Overrides

Service.getUrl

Source

packages/core/src/stores/store.ts:755

getUuidField()

getUuidField(): string

Return the model uuid field

Returns

string

Source

packages/core/src/stores/store.ts:2457

getWebda()

getWebda(): Core<CoreEvents>

Return WebdaCore

handleModel()

handleModel(model): number

Return if a model is handled by the store

Parameters

• model: CoreModel | Constructor<CoreModel>

Returns

number

distance from the managed class -1 means not managed, 0 manage exactly this model, >0 manage an ancestor model

Source

packages/core/src/stores/store.ts:717

httpAction()

httpAction(ctx, actionMethod?): Promise<void>

Handle obect action

Parameters

• ctx: WebContext<any, any>

• actionMethod?: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2186

httpCreate()

httpCreate(ctx): Promise<void>

Handle POST

Parameters

• ctx: WebContext<any, any>

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2146

httpDelete()

httpDelete(ctx): Promise<void>

Handle HTTP request

Parameters

• ctx: WebContext<any, any>

context of the request

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2436

httpGet()

httpGet(ctx): Promise<void>

Handle GET on object

Parameters

• ctx: WebContext<any, any>

context of the request

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2390

httpGlobalAction()

httpGlobalAction(ctx, model): Promise<void>

Handle collection action

Parameters

• ctx: WebContext<any, any>

• model: CoreModelDefinition<CoreModel>= undefined

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2233

httpQuery()

httpQuery(ctx): Promise<void>

Expose query to http

Parameters

• ctx: WebContext<any, any>

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1275

httpUpdate()

httpUpdate(ctx): Promise<void>

Handle HTTP Update for an object

Parameters

• ctx: WebContext<any, any>

context of the request

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2306

incrementAttribute()

incrementAttribute<FK>(uid, prop, value): Promise<Date>

Helper function that call incrementAttributes

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

• prop: FK

• value: number

Returns

Promise<Date>

Source

packages/core/src/stores/store.ts:1028

incrementAttributes()

incrementAttributes<FK>(uid, info): Promise<Date>

Increment attributes of an object

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

• info: Object[]

Returns

Promise<Date>

Source

packages/core/src/stores/store.ts:997

init()

init(): Promise<Store<T, K, E>>

Will be called after all the Services are created

Returns

Promise<Store<T, K, E>>

Inherited from

Service.init

Abstract

Source

packages/core/src/services/service.ts:570

initMetrics()

initMetrics(): void

Returns

void

Overrides

Service.initMetrics

Source

packages/core/src/stores/store.ts:678

initModel()

protected initModel(object): T

Init a model from the current stored data

Initial the reverse map as well

Parameters

• object: any= {}

Returns

T

Source

packages/core/src/stores/store.ts:923

initOperations()

initOperations(): void

Init the operations

Returns

void

Inherited from

Service.initOperations

Source

packages/core/src/services/service.ts:528

initRoutes()

initRoutes(): void

Init the routes

Returns

void

Overrides

Service.initRoutes

Source

packages/core/src/stores/store.ts:782

invalidateCache()

invalidateCache(uid): Promise<void>

Invalidate a cache entry

Parameters

• uid: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:668

iterate()

iterate(query, context?): AsyncGenerator<T, any, unknown>

Iterate through the results

This can be resource consuming

Parameters

• query: string= ""

• context?: OperationContext<any, any>

Returns

AsyncGenerator<T, any, unknown>

Source

packages/core/src/stores/store.ts:1125

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

Service.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

Service.listeners

Since

v0.1.26

Source

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

loadParameters()

abstract loadParameters(params): StoreParameters

Load the parameters for a service

Parameters

• params: any

Returns

StoreParameters

Overrides

Service.loadParameters

Source

packages/core/src/stores/store.ts:604

log()

log(level, ...args): void

Parameters

• level: WorkerLogLevel

to log

• ...args: any[]

Returns

void

Inherited from

Service.log

Source

packages/core/src/services/service.ts:662

logSlowQuery()

logSlowQuery(_query, _reason, _time): void

Parameters

• _query: string

• _reason: string

• _time: number

Returns

void

Source

packages/core/src/stores/store.ts:660

migration()

migration(name, patcher, batchSize): Promise<void>

Add a migration mechanism to store

Parameters

• name: string

• patcher: (object) => Promise<Partial<T> | () => Promise<void>>

• batchSize: number= 500

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1772

newModel()

newModel(object): T

Get a new model with this data preloaded

Parameters

• object: any= {}

Returns

T

Implementation of

MappingService.newModel

Source

packages/core/src/stores/store.ts:970

off()

off(eventName, listener): this

Alias for emitter.removeListener().

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Service.off

Since

v10.0.0

Source

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

on()

on<Key>(event, listener): this

Type the listener part

Type parameters

• Key extends string | number | symbol

Parameters

• event: symbol | Key

• listener: (evt) => void

Returns

this

Inherited from

Service.on

Source

packages/core/src/services/service.ts:607

onAsync()

onAsync<Key>(event, listener, queue): void

Listen to an event as on(...) would do except that it will be asynchronous

Type parameters

• Key extends string | number | symbol

Parameters

• event: Key

• listener: (evt) => void

• queue: string= undefined

Name of queue to use, can be undefined, queue name are used to define differents priorities

Returns

void

Inherited from

Service.onAsync

Source

packages/core/src/services/service.ts:618

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

Service.once

Since

v0.3.0

Source

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

operationCreate()

operationCreate(ctx, model): Promise<void>

Create a new object based on the context

Parameters

• ctx: OperationContext<any, any>

• model: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2155

patch()

patch<FK>(object, reverseMap, conditionField?, conditionValue?): Promise<T>

Patch an object

Type parameters

• FK extends string | number | symbol

Parameters

• object: Partial<T>

• reverseMap: boolean= true

• conditionField?: FK

• conditionValue?: any

Returns

Promise<T>

Source

packages/core/src/stores/store.ts:1432

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

Service.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

Service.prependOnceListener

Since

v6.0.0

Source

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

put()

put(uuid, data): Promise<T>

Upsert the uuid object

Parameters

• uuid: string

• data: Partial<T>

Returns

Promise<T>

Source

packages/core/src/stores/store.ts:1979

query()

query(query, context?): Promise<Object>

Query store with WebdaQL

Parameters

• query: string

• context?: OperationContext<any, any>

to apply permission

Returns

Promise<Object>

continuationToken?

continuationToken?: string

results

results: T[]

Source

packages/core/src/stores/store.ts:1172

queryAll()

queryAll(query, context?): Promise<T[]>

Query all the results

Parameters

• query: string

• context?: OperationContext<any, any>

Returns

Promise<T[]>

Deprecated

use iterate instead

Source

packages/core/src/stores/store.ts:1150

queryTypeUpdater()

queryTypeUpdater(query): Query

Check that __type Comparison is only used with = and CONTAINS If CONTAINS is used, move __type to __types If __type = store._model, remove it

Parameters

• query: Query

Returns

Query

Source

packages/core/src/stores/store.ts:1164

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

Service.rawListeners

Since

v9.4.0

Source

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

recomputeTypeCase()

recomputeTypeCase(): Promise<void>

Recompute type case

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1703

recomputeTypeShortId()

recomputeTypeShortId(): Promise<void>

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1662

recomputeTypes()

recomputeTypes(): Promise<void>

Recompute the __types for all objects (storeMigration.Registry.typesCompute)

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1727

reinit()

reinit(config): Promise<Store<T, K, E>>

Parameters

• config: DeepPartial<K>

new parameters for the service

Returns

Promise<Store<T, K, E>>

Inherited from

Service.reinit

Source

packages/core/src/services/service.ts:579

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

Service.removeAllListeners

Since

v0.1.26

Source

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

removeAttribute()

removeAttribute<CK>(uuid, attribute, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Remove an attribute from an object

Type parameters

• CK extends string | number | symbol

Parameters

• uuid: string

• attribute: CK

• itemWriteCondition?: any

• itemWriteConditionField?: CK

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1821

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

Service.removeListener

Since

v0.1.26

Source

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

resolve()

resolve(): this

Resolve parameters Call initRoutes and initBeanRoutes

Returns

this

Inherited from

Service.resolve

Source

packages/core/src/services/service.ts:388

save()

save(object, ctx): Promise<T>

Save an object

Parameters

• object: any

• ctx: OperationContext<any, any>= undefined

Returns

Promise<T>

with saved object

Might want to rename to create

Source

packages/core/src/stores/store.ts:1362

setAttribute()

setAttribute<CK>(uid, property, value): Promise<void>

Set one attribute in an object

this is an helper function that calls patch

Type parameters

• CK extends string | number | symbol

Parameters

• uid: string

of the object

• property: CK

to update1

• value: any

new value

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:2028

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

Service.setMaxListeners

Since

v0.3.5

Source

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

setModel()

setModel(model): void

OVerwrite the model Used mainly in test

Parameters

• model: CoreModelDefinition<T>

Returns

void

Source

packages/core/src/stores/store.ts:882

simulateFind()

protected simulateFind(query, uuids): Promise<StoreFindResult<T>>

Parameters

• query: Query

• uuids: string[]

Returns

Promise<StoreFindResult<T>>

Source

packages/core/src/stores/store.ts:2038

simulateUpsertItemToCollection()

simulateUpsertItemToCollection<FK>(model, prop, item, updateDate, index?, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Type parameters

• FK extends string | number | symbol

Parameters

• model: T

• prop: FK

• item: any

• updateDate: Date

• index?: number

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1528

stop()

stop(): Promise<void>

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

Service.stop

Source

packages/core/src/services/service.ts:373

toJSON()

toJSON(): string

Prevent service to be serialized

Returns

string

Inherited from

Service.toJSON

Source

packages/core/src/services/service.ts:560

toPublicJSON()

toPublicJSON(object): string

Convert an object to JSON using the Webda json filter

Parameters

• object: unknown

The object to export

Returns

string

The export of the strip object ( removed all attribute with _ )

Inherited from

Service.toPublicJSON

Source

packages/core/src/services/service.ts:552

toString()

toString(): string

Return service representation

Returns

string

Inherited from

Service.toString

Source

packages/core/src/services/service.ts:380

update()

update<CK>(object, reverseMap, partial, conditionField?, conditionValue?): Promise<T>

Update an object

If no attribute can be updated then return undefined

Type parameters

• CK extends string | number | symbol

Parameters

• object: any

• reverseMap: boolean= true

internal use only, for disable map resolution

• partial: boolean= false

• conditionField?: CK

• conditionValue?: any

Returns

Promise<T>

with saved object

Source

packages/core/src/stores/store.ts:1563

upsertItemToCollection()

upsertItemToCollection<FK>(uid, prop, item, index, itemWriteCondition, itemWriteConditionField): Promise<Date>

Add or update an item to an array in the model

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

of the model

• prop: FK

of the model to add in

• item: any

to add in the array

• index: number= undefined

if specified update item in this index

• itemWriteCondition: any= undefined

value of the condition to test (in case of update)

• itemWriteConditionField: string= undefined

field to read the condition from (in case of update)

Returns

Promise<Date>

Source

packages/core/src/stores/store.ts:1042

v3Migration()

v3Migration(): Promise<void>

Manage the store migration for __type case sensitivity

Returns

Promise<void>

Source

packages/core/src/stores/store.ts:1651

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

Service.getEventListeners

Since

v15.2.0, v14.17.0

Source

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

getOpenAPI()

static getOpenAPI(): void

Returns

void

Source

packages/core/src/stores/store.ts:778

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

Service.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

Service.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

Service.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

Service.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

Service.setMaxListeners

Since

v15.4.0

Source

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

Class: abstract Store<T, K, E>

Extends​

Type parameters​

Implements​

Constructors​

new Store(webda, name, params)​

Parameters​

Returns​

Inherited from​

Source​

Properties​

_cacheStore​

Source​

_createException​

Inherited from​

Source​

_initException​

Inherited from​

Source​

_initTime​

Inherited from​

Source​

_model​

Source​

_modelType​

Source​

_modelsHierarchy​

Index signature​

Source​

_name​

Inherited from​

Source​

_reverseMap​

Source​

_uuidField​

Source​

_webda​

Inherited from​

Source​

logger​

Inherited from​

Source​

metrics​

Type declaration​

cache_hits​

cache_invalidations​

operations_total​

queries​

slow_queries_total​

Overrides​

Source​

parameters​

Inherited from​

Source​

captureRejectionSymbol​

Inherited from​

Source​

captureRejections​

Inherited from​

Source​

defaultMaxListeners​

Inherited from​

Source​

errorMonitor​

Inherited from​

Source​

Methods​

__clean()​

Returns​

Inherited from​

Abstract​

Source​

_delete()​

Parameters​

Returns​

Source​

_deleteItemFromCollection()​

Parameters​

Returns​

Source​

Class: `abstract` Store<T, K, E>

Extends

Type parameters

Implements

Constructors

new Store(webda, name, params)

Parameters

Returns

Inherited from

Source

Properties

_cacheStore

Source

_createException

Inherited from

Source

_initException

Inherited from

Source

_initTime

Inherited from

Source

_model

Source

_modelType

Source

_modelsHierarchy

Index signature

Source

_name

Inherited from

Source

_reverseMap

Source

_uuidField

Source

_webda

Inherited from

Source

logger

Inherited from

Source

metrics

Type declaration

cache_hits

cache_invalidations

operations_total

queries

slow_queries_total

Overrides

Source

parameters

Inherited from

Source

captureRejectionSymbol

Inherited from

Source

captureRejections

Inherited from

Source

defaultMaxListeners

Inherited from

Source

errorMonitor

Inherited from

Source

Methods

__clean()

Returns

Inherited from

Abstract

Source

_delete()

Parameters

Returns

Source

_deleteItemFromCollection()

Parameters

Returns

Source