MonitoringStore | Community Solid Server

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

Type parameters

T: ResourceStore = ResourceStore

Hierarchy

EventEmitter
- MonitoringStore

Implements

ResourceStore

Constructors

constructor

new MonitoringStore<T>(source: T): MonitoringStore<T>

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

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>

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

addResource

addResource(container: ResourceIdentifier, representation: Representation, conditions?: Conditions): Promise<ResourceIdentifier>

Implementation of ResourceStore.addResource
- Defined in src/storage/MonitoringStore.ts:31
Creates a new resource in the container.

Parameters
- container: ResourceIdentifier
- representation: Representation
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier>

deleteResource

deleteResource(identifier: ResourceIdentifier, conditions?: Conditions): Promise<ResourceIdentifier[]>

Implementation of ResourceStore.deleteResource
- Defined in src/storage/MonitoringStore.ts:38
Deletes a resource.

Parameters
- identifier: ResourceIdentifier
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier[]>

emit

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

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

Private emitChanged

emitChanged(identifiers: ResourceIdentifier[]): ResourceIdentifier[]

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

eventNames

eventNames(): (string | symbol)[]

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

getMaxListeners

getMaxListeners(): number

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

getRepresentation

getRepresentation(identifier: ResourceIdentifier, preferences: RepresentationPreferences, conditions?: Conditions): Promise<Representation>

Implementation of ResourceStore.getRepresentation
- Defined in src/storage/MonitoringStore.ts:26
Retrieves a representation of a resource.

Parameters
- identifier: ResourceIdentifier
- preferences: RepresentationPreferences
- Optional conditions: Conditions
Returns Promise<Representation>

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

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

modifyResource

modifyResource(identifier: ResourceIdentifier, patch: Patch, conditions?: Conditions): Promise<ResourceIdentifier[]>

Implementation of ResourceStore.modifyResource
- Defined in src/storage/MonitoringStore.ts:48
Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.

Parameters
- identifier: ResourceIdentifier
- patch: Patch
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier[]>

off

off(event: string | symbol, listener: (...args: any[]) => void): MonitoringStore<T>

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

on

on(event: string | symbol, listener: (...args: any[]) => void): MonitoringStore<T>

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

once

once(event: string | symbol, listener: (...args: any[]) => void): MonitoringStore<T>

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

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): MonitoringStore<T>

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

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): MonitoringStore<T>

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

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): MonitoringStore<T>

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

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): MonitoringStore<T>

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

resourceExists

resourceExists(identifier: ResourceIdentifier, conditions?: Conditions): Promise<boolean>

Implementation of ResourceStore.resourceExists
- Defined in src/storage/MonitoringStore.ts:22
Check if a resource exists.

Parameters
- identifier: ResourceIdentifier
- Optional conditions: Conditions
Returns Promise<boolean>

setMaxListeners

setMaxListeners(n: number): MonitoringStore<T>

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

setRepresentation

setRepresentation(identifier: ResourceIdentifier, representation: Representation, conditions?: Conditions): Promise<ResourceIdentifier[]>

Implementation of ResourceStore.setRepresentation
- Defined in src/storage/MonitoringStore.ts:43
Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.

Parameters
- identifier: ResourceIdentifier
- representation: Representation
- Optional conditions: Conditions
Returns Promise<ResourceIdentifier[]>

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26
deprecated
since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

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

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

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

Type parameters

T: ResourceStore = ResourceStore

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T: 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

Parameters

container: ResourceIdentifier

representation: Representation

Optional conditions: Conditions

Returns Promise<ResourceIdentifier>

deleteResource

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

Parameters

identifier: ResourceIdentifier

preferences: RepresentationPreferences

Optional conditions: Conditions

Returns Promise<Representation>

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

modifyResource

Parameters

identifier: ResourceIdentifier

patch: Patch

Optional conditions: Conditions

Returns Promise<ResourceIdentifier[]>

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]