git-documentdb-plugin-remote-nodegit/dist/types.d.ts

GitDocumentDB plugin for remote connection using NodeGit

/**
 * Synchronization direction
 *
 * @remarks
 *
 * - pull: Only download from remote to local (currently not implemented)
 *
 * - push: Only upload from local to remote
 *
 * - both: Both download and upload between remote and local
 *
 * @public
 */
export declare type SyncDirection = 'pull' | 'push' | 'both';
/**
 * Connection settings for GitHub
 *
 * @remarks
 * - personalAccessToken: See https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
 *
 * - private: Whether the automatically created repository is private or not. Default is true.
 *
 * @public
 */
export declare type ConnectionSettingsGitHub = {
    type: 'github';
    personalAccessToken?: string;
    private?: boolean;
};
/**
 * Connection settings for SSH
 *
 * @public
 */
export declare type ConnectionSettingsSSH = {
    type: 'ssh';
    privateKeyPath: string;
    publicKeyPath: string;
    passPhrase?: string;
};
/**
 * Connection settings do not exist.
 *
 * @public
 */
export declare type ConnectionSettingsNone = {
    type: 'none';
};
/**
 * Connection settings for RemoteOptions
 *
 * @public
 */
export declare type ConnectionSettings = ConnectionSettingsNone | ConnectionSettingsGitHub | ConnectionSettingsSSH;
export declare type RemoteOptions = {
    remoteUrl?: string;
    syncDirection?: SyncDirection;
    connection?: ConnectionSettings;
    retry?: number;
    retryInterval?: number;
};
//# sourceMappingURL=types.d.ts.map