Class Audit

Hierarchy

CreateDestroyStartStop
- Audit

Constructors

constructor

new Audit(__namedParameters): Audit
Parameters
- __namedParameters: {
      db: DB;
      discovery: Discovery;
      logger: Logger;
      nodeConnectionManager: NodeConnectionManager;
  }
  - db: DB
  - discovery: Discovery
  - logger: Logger
  - nodeConnectionManager: NodeConnectionManager
Returns Audit
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/audit/Audit.ts:82

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` auditDbPath

auditDbPath: readonly (string | Buffer)[] = ...

`Protected` auditEventDbPath

auditEventDbPath: readonly (string | Buffer)[] = ...

`Protected` auditTopicDbPath

auditTopicDbPath: readonly (string | Buffer)[] = ...

`Protected` db

db: DB

`Protected` dbLastAuditEventIdPath

dbLastAuditEventIdPath: readonly (string | Buffer)[] = ...

`Protected` discovery

discovery: Discovery

`Protected` eventHandlerMap

eventHandlerMap: Map<typeof AbstractEvent, {
handler: ((evt) => Promise<void>);
target: EventTarget;
}> = ...

Type declaration

handler: ((evt) => Promise<void>)
- - (evt): Promise<void>
 - Parameters
 - evt: AbstractEvent<unknown>
 Returns Promise<void>
target: EventTarget

`Protected` generateAuditEventId

generateAuditEventId: (() => AuditEventId)

Type declaration

- (): AuditEventId
- Returns AuditEventId

`Protected` logger

logger: Logger

`Protected` nodeConnectionManager

nodeConnectionManager: NodeConnectionManager

`Protected` taskPromises

taskPromises: Set<PromiseCancellable<void>> = ...

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroyStartStop.CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroyStartStop.CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from createDestroyStartStop.CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.destroy
- Defined in src/audit/Audit.ts:181

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroyStartStop.CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getAuditEvents

getAuditEvents<T>(topicPath, __namedParameters?, tran?): AsyncGenerator<TopicSubPathToAuditEvent<T>, any, unknown>
Type Parameters
- T extends TopicSubPath
Parameters
- topicPath: T
- __namedParameters: {
 limit?: number;
 order?: "asc" | "desc";
 seek?: number | Date | AuditEventId;
 seekEnd?: number | Date | AuditEventId;
 } = {}
 - Optional limit?: number
 - Optional order?: "asc" | "desc"
 - Optional seek?: number | Date | AuditEventId
 - Optional seekEnd?: number | Date | AuditEventId
- Optional tran: DBTransaction
Returns AsyncGenerator<TopicSubPathToAuditEvent<T>, any, unknown>
- Defined in src/audit/Audit.ts:375

getAuditEventsLongRunning

getAuditEventsLongRunning<T>(topicPath, __namedParameters?): AsyncGenerator<TopicSubPathToAuditEvent<T>, any, unknown>
Type Parameters
- T extends TopicSubPath
Parameters
- topicPath: T
- __namedParameters: {
 limit?: number;
 seek?: number | Date | AuditEventId;
 seekEnd?: number | Date | AuditEventId;
 } = {}
 - Optional limit?: number
 - Optional seek?: number | Date | AuditEventId
 - Optional seekEnd?: number | Date | AuditEventId
Returns AsyncGenerator<TopicSubPathToAuditEvent<T>, any, unknown>
- Defined in src/audit/Audit.ts:274

getAuditMetric

getAuditMetric<T>(metricPath, options?, tran?): Promise<MetricPathToAuditMetric<T>>
Type Parameters
- T extends readonly ["node", "connection"] | readonly ["node", "connection", "inbound"] | readonly ["node", "connection", "outbound"]
Parameters
- metricPath: T
- options: {
 seek?: number | Date | AuditEventId;
 seekEnd?: number | Date | AuditEventId;
 } = {}
 - Optional seek?: number | Date | AuditEventId
 - Optional seekEnd?: number | Date | AuditEventId
- Optional tran: DBTransaction
Returns Promise<MetricPathToAuditMetric<T>>
- Defined in src/audit/Audit.ts:482

getLastAuditEventId

getLastAuditEventId(tran?): Promise<undefined | AuditEventId>
Parameters
- Optional tran: DBTransaction
Returns Promise<undefined | AuditEventId>
- Defined in src/audit/Audit.ts:187

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroyStartStop.CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

`Protected` setAuditEvent

setAuditEvent<T>(topicPath, auditEvent, tran?): any
Type Parameters
- T extends readonly ["node", "connection", "reverse"] | readonly ["node", "connection", "forward"] | readonly ["discovery", "vertex", "queued"] | readonly ["discovery", "vertex", "processed"] | readonly ["discovery", "vertex", "failed"] | readonly ["discovery", "vertex", "culled"] | readonly ["discovery", "vertex", "cancelled"] | readonly ["discovery", "checkRediscovery"]
Parameters
- topicPath: readonly ["node", "connection", "reverse"] | readonly ["node", "connection", "forward"] | readonly ["discovery", "vertex", "queued"] | readonly ["discovery", "vertex", "processed"] | readonly ["discovery", "vertex", "failed"] | readonly ["discovery", "vertex", "culled"] | readonly ["discovery", "vertex", "cancelled"] | readonly ["discovery", "checkRediscovery"]
- auditEvent: TopicSubPathToAuditEvent<T>
- Optional tran: DBTransaction
Returns any
- Defined in src/audit/Audit.ts:232

`Protected` setEventHandler

setEventHandler<T, P>(target, event, topicPath, toAuditEvent): void
Type Parameters
- T extends typeof AbstractEvent
- P extends readonly ["node", "connection", "reverse"] | readonly ["node", "connection", "forward"] | readonly ["discovery", "vertex", "queued"] | readonly ["discovery", "vertex", "processed"] | readonly ["discovery", "vertex", "failed"] | readonly ["discovery", "vertex", "culled"] | readonly ["discovery", "vertex", "cancelled"] | readonly ["discovery", "checkRediscovery"]
Parameters
- target: EventTarget
- event: T
- topicPath: P
- toAuditEvent: ((evt) => TopicSubPathToAuditEvent["data"] | Promise<TopicSubPathToAuditEvent["data"]>)
 - - (evt): TopicSubPathToAuditEvent["data"] | Promise<TopicSubPathToAuditEvent["data"]>
 - Parameters
 
 evt: InstanceType<T>
 
 Returns TopicSubPathToAuditEvent["data"] | Promise<TopicSubPathToAuditEvent["data"]>
Returns void
- Defined in src/audit/Audit.ts:201

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
 fresh?: boolean;
 } = {}
 - Optional fresh?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.start
- Defined in src/audit/Audit.ts:99

stop

stop(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
 force?: boolean;
 } = {}
 - Optional force?: boolean
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/audit/Audit.ts:166

`Static` createAudit

createAudit(__namedParameters): Promise<Audit>
Parameters
- __namedParameters: {
 db: DB;
 discovery: Discovery;
 fresh?: boolean;
 logger?: Logger;
 nodeConnectionManager: NodeConnectionManager;
 }
 - db: DB
 - discovery: Discovery
 - Optional fresh?: boolean
 - Optional logger?: Logger
 - nodeConnectionManager: NodeConnectionManager
Returns Promise<Audit>
- Defined in src/audit/Audit.ts:40

Class Audit

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; discovery: Discovery; logger: Logger; nodeConnectionManager: NodeConnectionManager; }

db: DB

discovery: Discovery

logger: Logger

nodeConnectionManager: NodeConnectionManager

Returns Audit

Properties

Readonly [initLock]

Protected auditDbPath

Protected auditEventDbPath

Protected auditTopicDbPath

Protected db

Protected dbLastAuditEventIdPath

Protected discovery

Protected eventHandlerMap

Type declaration

handler: ((evt) => Promise<void>)

Parameters

evt: AbstractEvent<unknown>

Returns Promise<void>

target: EventTarget

Protected generateAuditEventId

Type declaration

Returns AuditEventId

Protected logger

Protected nodeConnectionManager

Protected taskPromises

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

getAuditEvents

Type Parameters

T extends TopicSubPath

Parameters

topicPath: T

__namedParameters: { limit?: number; order?: "asc" | "desc"; seek?: number | Date | AuditEventId; seekEnd?: number | Date | AuditEventId; } = {}

Optional limit?: number

Optional order?: "asc" | "desc"

Optional seek?: number | Date | AuditEventId

Optional seekEnd?: number | Date | AuditEventId

__namedParameters: {
db: DB;
discovery: Discovery;
logger: Logger;
nodeConnectionManager: NodeConnectionManager;
}

`Readonly` [initLock]

`Protected` auditDbPath

`Protected` auditEventDbPath

`Protected` auditTopicDbPath

`Protected` db

`Protected` dbLastAuditEventIdPath

`Protected` discovery

`Protected` eventHandlerMap

`Protected` generateAuditEventId

`Protected` logger

`Protected` nodeConnectionManager

`Protected` taskPromises

`Optional` options: boolean | AddEventListenerOptions

__namedParameters: {
limit?: number;
order?: "asc" | "desc";
seek?: number | Date | AuditEventId;
seekEnd?: number | Date | AuditEventId;
} = {}

`Optional` limit?: number

`Optional` order?: "asc" | "desc"

`Optional` seek?: number | Date | AuditEventId

`Optional` seekEnd?: number | Date | AuditEventId

`Optional` tran: DBTransaction

__namedParameters: {
limit?: number;
seek?: number | Date | AuditEventId;
seekEnd?: number | Date | AuditEventId;
} = {}

`Optional` limit?: number

`Optional` seek?: number | Date | AuditEventId

`Optional` seekEnd?: number | Date | AuditEventId

options: {
seek?: number | Date | AuditEventId;
seekEnd?: number | Date | AuditEventId;
} = {}

`Optional` seek?: number | Date | AuditEventId

`Optional` seekEnd?: number | Date | AuditEventId

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` options: boolean | EventListenerOptions

`Protected` setAuditEvent

`Optional` tran: DBTransaction

`Protected` setEventHandler

__namedParameters: {
fresh?: boolean;
} = {}

`Optional` fresh?: boolean

__namedParameters: {
force?: boolean;
} = {}

`Optional` force?: boolean

`Static` createAudit

__namedParameters: {
db: DB;
discovery: Discovery;
fresh?: boolean;
logger?: Logger;
nodeConnectionManager: NodeConnectionManager;
}

`Optional` fresh?: boolean

`Optional` logger?: Logger