Skip to main content

Class: EntityStorageLoggingConnector

Class for performing logging operations in entity storage.

Implements​

  • ILoggingConnector

Constructors​

Constructor​

new EntityStorageLoggingConnector(options?): EntityStorageLoggingConnector

Create a new instance of EntityStorageLoggingConnector.

Parameters​

options?​

IEntityStorageLoggingConnectorConstructorOptions

The options for the connector.

Returns​

EntityStorageLoggingConnector

Properties​

NAMESPACE​

readonly static NAMESPACE: string = "entity-storage"

The namespace for the logging connector.

CLASS_NAME​

readonly static CLASS_NAME: string

Runtime name for the class.

Methods​

className()​

className(): string

Returns the class name of the component.

Returns​

string

The class name of the component.

Implementation of​

ILoggingConnector.className

log()​

log(logEntry): Promise<void>

Log an entry to the connector.

Parameters​

logEntry​

ILogEntry

The entry to log.

Returns​

Promise<void>

Nothing.

Implementation of​

ILoggingConnector.log

query()​

query(conditions?, sortProperties?, properties?, cursor?, limit?): Promise<{ entities: Partial<ILogEntry>[]; cursor?: string; }>

Query the log entries.

Parameters​

conditions?​

EntityCondition<ILogEntry>

The conditions to match for the entities.

sortProperties?​

object[]

The optional sort order.

properties?​

keyof ILogEntry[]

The optional keys to return, defaults to all.

cursor?​

string

The cursor to request the next chunk of entities.

limit?​

number

Limit the number of entities to return.

Returns​

Promise<{ entities: Partial<ILogEntry>[]; cursor?: string; }>

All the entities for the storage matching the conditions, and a cursor which can be used to request more entities.

Implementation of​

ILoggingConnector.query