Class MonitoringStore<T>

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

Constructors

constructor

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

Properties

addListener

addListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

emit

emit: ((event, ...args) => boolean) & ((event, ...args) => boolean)

eventNames

eventNames: (() => "changed"[]) & (() => ("https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[])

listenerCount

listenerCount: ((event) => number) & ((event) => number)

listeners

listeners: ((event) => ((target, activity, metadata) => void)[]) & ((event) => ((target, metadata) => void)[])

off

off: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

on

on: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

once

once: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

prependListener

prependListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

prependOnceListener

prependOnceListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

rawListeners

rawListeners: ((event) => ((target, activity, metadata) => void)[]) & ((event) => ((target, metadata) => void)[])

removeAllListeners

removeAllListeners: ((event) => MonitoringStore<T>) & ((event) => MonitoringStore<T>)

removeListener

removeListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)

`Private` `Readonly` source

source: T

Methods

addResource

addResource(container, representation, conditions?): Promise<ChangeMap>
Creates a new resource in the container.
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<ChangeMap>
A ChangeMap.
Implementation of ResourceStore.addResource
- Defined in src/storage/MonitoringStore.ts:36

deleteResource

deleteResource(identifier, conditions?): Promise<ChangeMap>
Deletes a resource.
Parameters
- identifier: ResourceIdentifier
  
  Identifier of resource to delete.
- Optional conditions: Conditions
  
  Optional conditions under which to proceed.
Returns Promise<ChangeMap>
A ChangeMap.
Implementation of ResourceStore.deleteResource
- Defined in src/storage/MonitoringStore.ts:41

`Private` emitChanged

emitChanged(changes): ChangeMap
Parameters
- changes: ChangeMap
Returns ChangeMap
- Defined in src/storage/MonitoringStore.ts:56

getMaxListeners

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

getRepresentation

getRepresentation(identifier, preferences, conditions?): Promise<Representation>
Retrieves a representation of a resource.
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>
A representation corresponding to the identifier.
Implementation of ResourceStore.getRepresentation
- Defined in src/storage/MonitoringStore.ts:31

hasResource

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

`Private` isKnownActivity

isKnownActivity(term?): term is NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
Parameters
- Optional term: Term
Returns term is NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
- Defined in src/storage/MonitoringStore.ts:68

modifyResource

modifyResource(identifier, patch, conditions?): Promise<ChangeMap>
Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.
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<ChangeMap>
A ChangeMap.
Implementation of ResourceStore.modifyResource
- Defined in src/storage/MonitoringStore.ts:51

setMaxListeners

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

setRepresentation

setRepresentation(identifier, representation, conditions?): Promise<ChangeMap>
Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.
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<ChangeMap>
A ChangeMap.
Implementation of ResourceStore.setRepresentation
- Defined in src/storage/MonitoringStore.ts:46

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

addListener

emit

eventNames

listenerCount

listeners

off

on

once

prependListener

prependOnceListener

rawListeners

removeAllListeners

removeListener

Private Readonly source

Methods

addResource

Parameters

container: ResourceIdentifier

representation: Representation

Optional conditions: Conditions

Returns Promise<ChangeMap>

deleteResource

Parameters

identifier: ResourceIdentifier

Optional conditions: Conditions

Returns Promise<ChangeMap>

Private emitChanged

Parameters

changes: ChangeMap

Returns ChangeMap

getMaxListeners

Returns number

getRepresentation

Parameters

identifier: ResourceIdentifier

preferences: RepresentationPreferences

Optional conditions: Conditions

Returns Promise<Representation>

hasResource

Parameters

identifier: ResourceIdentifier

Returns Promise<boolean>

Private isKnownActivity

Parameters

Optional term: Term

modifyResource

Parameters

identifier: ResourceIdentifier

patch: Patch

Optional conditions: Conditions

Returns Promise<ChangeMap>

setMaxListeners

Parameters

n: number

Returns MonitoringStore<T>

setRepresentation

Parameters

identifier: ResourceIdentifier

representation: Representation

Optional conditions: Conditions

Returns Promise<ChangeMap>

Settings

Member Visibility

`Private` `Readonly` source

`Optional` conditions: Conditions

`Optional` conditions: Conditions

`Private` emitChanged

`Optional` conditions: Conditions

`Private` isKnownActivity

`Optional` term: Term

`Optional` conditions: Conditions

`Optional` conditions: Conditions