git-documentdb/dist/remote/remote_repository.d.ts

Offline-first database that syncs with Git

/**
 * GitDocumentDB
 * Copyright (c) Hidekazu Kubota
 *
 * This source code is licensed under the Mozilla Public License Version 2.0
 * found in the LICENSE file in the root directory of this source tree.
 */
import { RemoteOptions } from '../types';
/**
 * Remote repository class
 *
 * @public
 */
export declare class RemoteRepository {
    private _options;
    private _octokit;
    /**
     * Constructor
     *
     * @public
     */
    constructor(options: RemoteOptions);
    /**
     * Create a repository on a remote site
     *
     * @remarks
     * connection.type must be 'github'
     *
     * @throws {@link Err.UndefinedPersonalAccessTokenError}
     * @throws {@link Err.PersonalAccessTokenForAnotherAccountError}
     * @throws {@link Err.CannotConnectRemoteRepositoryError}
     *
     *  may include the following errors:
     *
     *  - HttpError
     *
     *  - Authentication error
     *
     *  - Permission error
     *
     *  - Other network errors
     *
     * @throws {@link Err.AuthenticationTypeNotAllowCreateRepositoryError}
     *
     * @public
     */
    create(): Promise<void>;
    /**
     * Delete a repository on a remote site
     *
     * @remarks
     * connection.type must be 'github'
     *
     * @throws {@link Err.UndefinedPersonalAccessTokenError}
     * @throws {@link Err.CannotConnectRemoteRepositoryError}
     *
     *  may include the following errors:
     *
     *  - HttpError
     *
     *  - Authentication error
     *
     *  - Permission for private repository error
     *
     *  - Other network errors
     *
     * @throws {@link Err.AuthenticationTypeNotAllowCreateRepositoryError}
     *
     * @public
     */
    destroy(): Promise<void>;
}
//# sourceMappingURL=remote_repository.d.ts.map