Class OneInstance

Hierarchy

OneInstance

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OneInstance(instanceOptions: InstanceOptions): OneInstance

- Defined in src/replicant/OneInstance.ts:49
Parameters
- instanceOptions: InstanceOptions
Returns OneInstance

Properties

defaultDirectory

defaultDirectory: string = "OneDB"

instanceOptions

instanceOptions: InstanceOptions

Methods

generateRandomInstanceNameOnce

generateRandomInstanceNameOnce(): Promise<string>

- Defined in src/replicant/OneInstance.ts:55
Returns Promise<string>

getSecret

getSecret(): string

- Defined in src/replicant/OneInstance.ts:122
return the secret used to create the instance

Returns string

init

init(): Promise<void>

- Defined in src/replicant/OneInstance.ts:71
Returns Promise<void>

instanceExists

instanceExists(): Promise<boolean>

- Defined in src/replicant/OneInstance.ts:90
Checks if the specified ONE storage directory exists and uses the default if not

Returns Promise<boolean>

Generated using TypeDoc