Class VaultInternal

Hierarchy

CreateDestroyStartStop
- VaultInternal

Constructors

constructor

new VaultInternal(__namedParameters): VaultInternal
Parameters
- __namedParameters: {
      db: DB;
      efs: EncryptedFS;
      keyRing: KeyRing;
      logger: Logger;
      vaultId: VaultId;
      vaultsDbPath: readonly (string | Buffer)[];
  }
  - db: DB
  - efs: EncryptedFS
  - keyRing: KeyRing
  - logger: Logger
  - vaultId: VaultId
  - vaultsDbPath: readonly (string | Buffer)[]
Returns VaultInternal
Inherited from CreateDestroyStartStop.constructor
- Defined in src/vaults/VaultInternal.ts:234

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` db

db: DB

`Protected` efs

efs: EncryptedFS

`Protected` efsVault

efsVault: EncryptedFS

`Protected` keyRing

keyRing: KeyRing

`Protected` lock

lock: RWLockWriter = ...

`Protected` logger

logger: Logger

`Readonly` vaultDataDir

vaultDataDir: string

`Readonly` vaultGitDir

vaultGitDir: string

`Readonly` vaultId

vaultId: VaultId

`Readonly` vaultIdEncoded

vaultIdEncoded: string

`Protected` vaultMetadataDbPath

vaultMetadataDbPath: readonly (string | Buffer)[]

`Protected` vaultsDbPath

vaultsDbPath: readonly (string | Buffer)[]

`Protected` vaultsNamesPath

vaultsNamesPath: readonly (string | Buffer)[]

`Static` dirtyKey

dirtyKey: string = 'dirty'

`Static` nameKey

nameKey: string = 'key'

`Static` remoteKey

remoteKey: string = 'remote'

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from 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.[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.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from 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.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from 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.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from 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.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

`Protected` cleanWorkingDirectory

cleanWorkingDirectory(): Promise<void>
Cleans the git working directory by checking out the canonicalBranch

Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:1000

`Protected` createCommit

createCommit(): Promise<void>
Creates a commit while moving the canonicalBranch reference

Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:855

destroy

destroy(tran?): Promise<void>
Parameters
- Optional tran: DBTransaction
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/vaults/VaultInternal.ts:337

`Protected` destroy_

destroy_(tran): Promise<void>
Parameters
- tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:344

dispatchEvent

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

`Protected` garbageCollectGitObjects

garbageCollectGitObjects(): Promise<void>
Deletes any git objects that can't be reached from the canonicalBranch

Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:1040

getLock

getLock(): RWLockWriter
Returns RWLockWriter
- Defined in src/vaults/VaultInternal.ts:230

log

log(ref?, limit?): Promise<CommitLog[]>
Parameters
- ref: string = 'HEAD'
- Optional limit: number
Returns Promise<CommitLog[]>
- Defined in src/vaults/VaultInternal.ts:362

`Protected` mkdirExists

mkdirExists(directory): Promise<void>
Parameters
- directory: string
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:318

pullVault

pullVault(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
      nodeConnectionManager: NodeConnectionManager;
      pullNodeId?: NodeId;
      pullVaultNameOrId?: string | VaultId;
      tran?: DBTransaction;
  }
  - nodeConnectionManager: NodeConnectionManager
  - Optional pullNodeId?: NodeId
  - Optional pullVaultNameOrId?: string | VaultId
  - Optional tran?: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:540

readF

readF<T>(f): Promise<T>
Type Parameters
- T
Parameters
- f: ((fs) => Promise<T>)
  - - (fs): Promise<T>
    - Parameters
      
      fs: FileSystemReadable
      
      Returns Promise<T>
Returns Promise<T>
- Defined in src/vaults/VaultInternal.ts:430

readG

readG<T, TReturn, TNext>(g): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- g: ((fs) => AsyncGenerator<T, TReturn, TNext>)
  - - (fs): AsyncGenerator<T, TReturn, TNext>
    - Parameters
      
      fs: FileSystemReadable
      
      Returns AsyncGenerator<T, TReturn, TNext>
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/vaults/VaultInternal.ts:437

removeEventListener

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

`Protected` request

request(client, vaultNameOrId, vaultAction): Promise<any[]>
Parameters
- client: RPCClient<{
      nodesClaimsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.ClaimIdMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
      nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<nodes.agent.types.NodeAddressMessage>>;
      nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
      nodesHolePunchMessageSend: UnaryCaller<AgentRPCRequestParams<HolePunchRelayMessage>, AgentRPCResponseResult>;
      notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
      vaultsGitInfoGet: RawCaller;
      vaultsGitPackGet: RawCaller;
      vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
  }>
- vaultNameOrId: string | VaultId
- vaultAction: "clone" | "pull"
Returns Promise<any[]>
- Defined in src/vaults/VaultInternal.ts:769

`Protected` setupGit

setupGit(tran): Promise<string>
Parameters
- tran: DBTransaction
Returns Promise<string>
- Defined in src/vaults/VaultInternal.ts:700

`Protected` setupMeta

setupMeta(__namedParameters): Promise<void>
Setup the vault metadata
Parameters
- __namedParameters: {
  tran: DBTransaction;
  vaultName?: string;
  }
  - tran: DBTransaction
  - Optional vaultName?: string
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:654

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
      fresh?: boolean;
      tran?: DBTransaction;
      vaultName?: string;
  } = {}
  - Optional fresh?: boolean
  - Optional tran?: DBTransaction
  - Optional vaultName?: string
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/vaults/VaultInternal.ts:267

`Protected` start_

start_(fresh, tran, vaultName?): Promise<void>
Parameters
- fresh: boolean
- tran: DBTransaction
- Optional vaultName: string
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:284

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/vaults/VaultInternal.ts:328

version

version(ref?): Promise<void>
Checks out the vault repository to specific commit ID or special tags This changes the working directory and updates the HEAD reference
Parameters
- ref: string = tagLast
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:401

writeF

writeF(f, tran?): Promise<void>
Parameters
- f: ((fs) => Promise<void>)
  - - (fs): Promise<void>
    - Parameters
      
      fs: FileSystemWritable
      
      Returns Promise<void>
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultInternal.ts:447

writeG

writeG<T, TReturn, TNext>(g, tran?): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- g: ((fs) => AsyncGenerator<T, TReturn, TNext>)
  - - (fs): AsyncGenerator<T, TReturn, TNext>
    - Parameters
      
      fs: FileSystemWritable
      
      Returns AsyncGenerator<T, TReturn, TNext>
- Optional tran: DBTransaction
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/vaults/VaultInternal.ts:494

`Static` cloneVaultInternal

cloneVaultInternal(__namedParameters): Promise<VaultInternal>
Parameters
- __namedParameters: {
      db: DB;
      efs: EncryptedFS;
      keyRing: KeyRing;
      logger?: Logger;
      nodeConnectionManager: NodeConnectionManager;
      targetNodeId: NodeId;
      targetVaultNameOrId: string | VaultId;
      tran?: DBTransaction;
      vaultId: VaultId;
      vaultsDbPath: readonly (string | Buffer)[];
  }
  - db: DB
  - efs: EncryptedFS
  - keyRing: KeyRing
  - Optional logger?: Logger
  - nodeConnectionManager: NodeConnectionManager
  - targetNodeId: NodeId
  - targetVaultNameOrId: string | VaultId
  - Optional tran?: DBTransaction
  - vaultId: VaultId
  - vaultsDbPath: readonly (string | Buffer)[]
Returns Promise<VaultInternal>
- Defined in src/vaults/VaultInternal.ts:109

`Static` createVaultInternal

createVaultInternal(__namedParameters): Promise<VaultInternal>
Parameters
- __namedParameters: {
      db: DB;
      efs: EncryptedFS;
      fresh?: boolean;
      keyRing: KeyRing;
      logger?: Logger;
      tran?: DBTransaction;
      vaultId: VaultId;
      vaultName?: string;
      vaultsDbPath: readonly (string | Buffer)[];
  }
  - db: DB
  - efs: EncryptedFS
  - Optional fresh?: boolean
  - keyRing: KeyRing
  - Optional logger?: Logger
  - Optional tran?: DBTransaction
  - vaultId: VaultId
  - Optional vaultName?: string
  - vaultsDbPath: readonly (string | Buffer)[]
Returns Promise<VaultInternal>
- Defined in src/vaults/VaultInternal.ts:57

Class VaultInternal

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; efs: EncryptedFS; keyRing: KeyRing; logger: Logger; vaultId: VaultId; vaultsDbPath: readonly (string | Buffer)[]; }

db: DB

efs: EncryptedFS

keyRing: KeyRing

logger: Logger

vaultId: VaultId

vaultsDbPath: readonly (string | Buffer)[]

Returns VaultInternal

Properties

Readonly [initLock]

Protected db

Protected efs

Protected efsVault

Protected keyRing

Protected lock

Protected logger

Readonly vaultDataDir

Readonly vaultGitDir

Readonly vaultId

Readonly vaultIdEncoded

Protected vaultMetadataDbPath

Protected vaultsDbPath

Protected vaultsNamesPath

Static dirtyKey

Static nameKey

Static remoteKey

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

Protected cleanWorkingDirectory

Returns Promise<void>

Protected createCommit

Returns Promise<void>

destroy

Parameters

Optional tran: DBTransaction

Returns Promise<void>

Protected destroy_

Parameters

tran: DBTransaction

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

Protected garbageCollectGitObjects

__namedParameters: {
db: DB;
efs: EncryptedFS;
keyRing: KeyRing;
logger: Logger;
vaultId: VaultId;
vaultsDbPath: readonly (string | Buffer)[];
}

`Readonly` [initLock]

`Protected` db

`Protected` efs

`Protected` efsVault

`Protected` keyRing

`Protected` lock

`Protected` logger

`Readonly` vaultDataDir

`Readonly` vaultGitDir

`Readonly` vaultId

`Readonly` vaultIdEncoded

`Protected` vaultMetadataDbPath

`Protected` vaultsDbPath

`Protected` vaultsNamesPath

`Static` dirtyKey

`Static` nameKey

`Static` remoteKey

`Optional` options: boolean | AddEventListenerOptions

`Protected` cleanWorkingDirectory

`Protected` createCommit

`Optional` tran: DBTransaction

`Protected` destroy_

`Protected` garbageCollectGitObjects

`Optional` limit: number

`Protected` mkdirExists

__namedParameters: {
nodeConnectionManager: NodeConnectionManager;
pullNodeId?: NodeId;
pullVaultNameOrId?: string | VaultId;
tran?: DBTransaction;
}

`Optional` pullNodeId?: NodeId

`Optional` pullVaultNameOrId?: string | VaultId

`Optional` tran?: DBTransaction

`Optional` options: boolean | EventListenerOptions

`Protected` request

`Protected` setupGit

`Protected` setupMeta

__namedParameters: {
tran: DBTransaction;
vaultName?: string;
}

`Optional` vaultName?: string

__namedParameters: {
fresh?: boolean;
tran?: DBTransaction;
vaultName?: string;
} = {}

`Optional` fresh?: boolean

`Optional` tran?: DBTransaction

`Optional` vaultName?: string

`Protected` start_