Home > git-documentdb > GitDDBInterface
GitDDBInterface interface#
Interface of GitDocumentDB body
Signature:Properties#
| Property | Type | Description |
|---|---|---|
| author | { name: string; email: string; } | |
| committer | { name: string; email: string; } | |
| dbId | string | |
| dbName | string | |
| defaultBranch | string | |
| isClosing | boolean | |
| isOpened | boolean | |
| localDir | string | |
| logger | ColoredLogger | |
| logLevel | TLogLevelName | ********************************************* Public properties ********************************************* |
| rootCollection | ICollection | |
| schema | Schema | |
| serializeFormat | SerializeFormatJSON | SerializeFormatFrontMatter | ********************************************* Public properties (readonly) ********************************************* |
| taskQueue | TaskQueue | |
| tsLogger | Logger | |
| validator | Validator | |
| workingDir | string |
Methods#
| Method | Description |
|---|---|
| close(options) | |
| destroy(options) | |
| getCommit(oid) | |
| getRemoteURLs() | |
| getSync(remoteURL) | |
| loadAuthor() | |
| loadDbInfo() | |
| open(options) | ********************************************* Public methods ********************************************* |
| removeSync(remoteURL) | |
| saveAuthor() | |
| sync(options, getSyncResult) | |
| sync(options) |