Class MonitoringStore<T>

Store that notifies listeners of changes to its source by emitting a changed event.

Type Parameters

T extends ResourceStore = ResourceStore

Hierarchy

EventEmitter
- MonitoringStore

Implements

ResourceStore

Constructors

constructor

new MonitoringStore<T>(source: T): MonitoringStore<T>
Type Parameters
- T extends ResourceStore = ResourceStore
Parameters
- source: T
Returns MonitoringStore<T>
Overrides EventEmitter.constructor
- Defined in src/storage/MonitoringStore.ts:17

Properties

`Private` `Readonly` source

source: T

`Static` `Readonly` captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

`Static` captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

`Static` defaultMaxListeners

defaultMaxListeners: number

`Static` `Readonly` errorMonitor

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.

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:57

addResource

addResource(container: ResourceIdentifier, representation: Representation, conditions?: Conditions): Promise<ResourceIdentifier>
Creates a new resource in the container.

Returns
The identifier of the newly created resource.
Parameters
- container: ResourceIdentifier
  
  Container in which to create a resource.
- representation: Representation
  
  Representation of the new resource
- Optional conditions: Conditions
  
  Optional conditions under which to proceed.
Returns Promise<ResourceIdentifier>
Implementation of ResourceStore.addResource
- Defined in src/storage/MonitoringStore.ts:31

deleteResource

deleteResource(identifier: ResourceIdentifier, conditions?: Conditions): Promise<ResourceIdentifier[]>
Deletes a resource.

Returns
Identifiers of resources that were possibly modified.
Parameters
- identifier: ResourceIdentifier
  
  Identifier of resource to delete.
- Optional conditions: Conditions
  
  Optional conditions under which to proceed.
Returns Promise<ResourceIdentifier[]>
Implementation of ResourceStore.deleteResource
- Defined in src/storage/MonitoringStore.ts:38

emit

emit(event: string | symbol, ...args: any[]): boolean
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:67

`Private` emitChanged

emitChanged(identifiers: ResourceIdentifier[]): ResourceIdentifier[]
Parameters
- identifiers: ResourceIdentifier[]
Returns ResourceIdentifier[]
- Defined in src/storage/MonitoringStore.ts:53

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:72

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64

getRepresentation

getRepresentation(identifier: ResourceIdentifier, preferences: RepresentationPreferences, conditions?: Conditions): Promise<Representation>
Retrieves a representation of a resource.

Returns
A representation corresponding to the identifier.
Parameters
- identifier: ResourceIdentifier
  
  Identifier of the resource to read.
- preferences: RepresentationPreferences
  
  Preferences indicating desired representations.
- Optional conditions: Conditions
  
  Optional conditions under which to proceed.
Returns Promise<Representation>
Implementation of ResourceStore.getRepresentation
- Defined in src/storage/MonitoringStore.ts:26

hasResource

hasResource(identifier: ResourceIdentifier): Promise<boolean>
Check if a resource exists in this ResourceSet.

Returns
A promise resolving if the resource already exists.
Parameters
- identifier: ResourceIdentifier
  
  Identifier of resource to check.
Returns Promise<boolean>
Implementation of ResourceStore.hasResource
- Defined in src/storage/MonitoringStore.ts:22

listenerCount

listenerCount(event: string | symbol): number
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68

listeners

listeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65

modifyResource

modifyResource(identifier: ResourceIdentifier, patch: Patch, conditions?: Conditions): Promise<ResourceIdentifier[]>
Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.

Returns
Identifiers of resources that were possibly modified.
Parameters
- identifier: ResourceIdentifier
  
  Identifier of resource to update.
- patch: Patch
  
  Description of which parts to update.
- Optional conditions: Conditions
  
  Optional conditions under which to proceed.
Returns Promise<ResourceIdentifier[]>
Implementation of ResourceStore.modifyResource
- Defined in src/storage/MonitoringStore.ts:48

off

off(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:61

on

on(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:58

once

once(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:59

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:70

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71

rawListeners

rawListeners(event: string | symbol): Function[]
Parameters
- event: string | symbol
Returns Function[]
Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66

removeAllListeners

removeAllListeners(event?: string | symbol): MonitoringStore<T>
Parameters
- Optional event: string | symbol
Returns MonitoringStore<T>
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): MonitoringStore<T>
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MonitoringStore<T>
Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:60

setMaxListeners

setMaxListeners(n: number): MonitoringStore<T>
Parameters
- n: number
Returns MonitoringStore<T>
Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63

setRepresentation

setRepresentation(identifier: ResourceIdentifier, representation: Representation, conditions?: Conditions): Promise<ResourceIdentifier[]>
Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.

Returns
Identifiers of resources that were possibly modified.
Parameters
- identifier: ResourceIdentifier
  
  Identifier of resource to update.
- representation: Representation
  
  New representation of the resource.
- Optional conditions: Conditions
  
  Optional conditions under which to proceed.
Returns Promise<ResourceIdentifier[]>
Implementation of ResourceStore.setRepresentation
- Defined in src/storage/MonitoringStore.ts:43

`Static` listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number
Deprecated
since v4.0.0
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>
Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23

`Static` once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
once(emitter: DOMEventTarget, event: string): Promise<any[]>
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22

Class MonitoringStore<T>

Type Parameters

T extends ResourceStore = ResourceStore

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends ResourceStore = ResourceStore

Parameters

source: T

Returns MonitoringStore<T>

Properties

Private Readonly source

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns MonitoringStore<T>

addResource

Returns

Parameters

container: ResourceIdentifier

representation: Representation

Optional conditions: Conditions

Returns Promise<ResourceIdentifier>

deleteResource

Returns

Parameters

identifier: ResourceIdentifier

Optional conditions: Conditions

Returns Promise<ResourceIdentifier[]>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Private emitChanged

Parameters

identifiers: ResourceIdentifier[]

Returns ResourceIdentifier[]

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

getRepresentation

Returns

Parameters

identifier: ResourceIdentifier

preferences: RepresentationPreferences

Optional conditions: Conditions

Returns Promise<Representation>

hasResource

Returns

Parameters

identifier: ResourceIdentifier

Returns Promise<boolean>

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

modifyResource

Returns

Parameters

`Private` `Readonly` source

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Optional` conditions: Conditions

`Optional` conditions: Conditions

`Rest` ...args: any[]

`Private` emitChanged

`Optional` conditions: Conditions

`Optional` conditions: Conditions

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]

`Optional` conditions: Conditions