Interface SiteRegistryOptions

Options of SiteRegistry.open.

interface SiteRegistryOptions {
    configDir?: string;
    lockTimeoutMs?: number;
    logger?: Logger;
    paths?: SyncServersPaths;
    stateDir?: string;
}

Hierarchy (View Summary)

PathsOptions
- SiteRegistryOptions

Index

Properties

configDir? lockTimeoutMs? logger? paths? stateDir?

Properties

`Optional` `Readonly`configDir

configDir?: string

Overrides the settings folder (--config-dir).

`Optional` `Readonly`lockTimeoutMs

lockTimeoutMs?: number

How long a write waits for another process's lock. Default 5 seconds.

`Optional` `Readonly`logger

logger?: Logger

Where additions, changes and removals are recorded.

`Optional` `Readonly`paths

paths?: SyncServersPaths

Use these folders instead of the defaults for this user and platform.

`Optional` `Readonly`stateDir

stateDir?: string

Overrides the state folder (--state-dir).