Class Schema

Hierarchy

CreateDestroyStartStop
- Schema

Index

Constructors

Properties

[initLock] fs lock logger statePath stateVersion stateVersionPath

Accessors

[destroyed] [eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Methods

addEventListener destroy dispatchEvent readVersion removeEventListener start stop upgradeVersion writeVersion createSchema

Constructors

constructor

new Schema(__namedParameters): Schema
Parameters
- __namedParameters: {
      fs: FileSystem;
      logger?: Logger;
      statePath: string;
      stateVersion?: StateVersion;
  }
  - fs: FileSystem
  - Optional logger?: Logger
  - statePath: string
  - Optional stateVersion?: StateVersion
Returns Schema
Inherited from createDestroyStartStop.CreateDestroyStartStop.constructor
- Defined in src/schema/Schema.ts:57

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` fs

`Protected` lock

lock: RWLockWriter = ...

`Protected` logger

logger: Logger

`Readonly` statePath

statePath: string

`Readonly` stateVersion

stateVersion: StateVersion

`Readonly` stateVersionPath

stateVersionPath: string

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/schema/Schema.ts:131

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

readVersion

readVersion(): Promise<undefined | StateVersion>
Returns Promise<undefined | StateVersion>
- Defined in src/schema/Schema.ts:152

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

start

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

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from createDestroyStartStop.CreateDestroyStartStop.stop
- Defined in src/schema/Schema.ts:126

`Protected` upgradeVersion

upgradeVersion(_stateVersion): Promise<void>
This is only called when the version is older.
Parameters
- _stateVersion: StateVersion
Returns Promise<void>
- Defined in src/schema/Schema.ts:207

`Protected` writeVersion

writeVersion(stateVersion): Promise<void>
Parameters
- stateVersion: StateVersion
Returns Promise<void>
- Defined in src/schema/Schema.ts:182

`Static` createSchema

createSchema(__namedParameters): Promise<Schema>
Parameters
- __namedParameters: {
      fresh?: boolean;
      fs?: FileSystem;
      logger?: Logger;
      statePath: string;
      stateVersion?: StateVersion;
  }
  - Optional fresh?: boolean
  - Optional fs?: FileSystem
  - Optional logger?: Logger
  - statePath: string
  - Optional stateVersion?: StateVersion
Returns Promise<Schema>
- Defined in src/schema/Schema.ts:24

Generated using TypeDoc