From 79e1866c4d273eb7e2613665e834370b007656e9 Mon Sep 17 00:00:00 2001 From: Dolan Date: Thu, 8 Jun 2017 02:40:20 +0100 Subject: [PATCH] Added documentation for Checkout --- types/nodegit/checkout.d.ts | 42 +++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/types/nodegit/checkout.d.ts b/types/nodegit/checkout.d.ts index af5f66faf3..a6ce5ff991 100644 --- a/types/nodegit/checkout.d.ts +++ b/types/nodegit/checkout.d.ts @@ -44,8 +44,50 @@ export namespace Checkout { } export class Checkout { + /** + * Patch head checkout to automatically coerce objects. + * + * @static + * @param {Repository} repo + * @param {CheckoutOptions} [options] + * @returns {Promise} + * + * @memberof Checkout + */ static head(repo: Repository, options?: CheckoutOptions): Promise; + /** + * Patch index checkout to automatically coerce objects. + * + * @static + * @param {Repository} repo + * @param {Index} The + * @param {CheckoutOptions} [options] + * @returns {Promise} + * + * @memberof Checkout + */ static index(repo: Repository, The: Index, options?: CheckoutOptions): Promise; + /** + * + * + * @static + * @param {CheckoutOptions} opts + * @param {number} version + * @returns {number} + * + * @memberof Checkout + */ static initOptions(opts: CheckoutOptions, version: number): number; + /** + * Patch tree checkout to automatically coerce objects. + * + * @static + * @param {Repository} repo + * @param {(Oid | Tree | Commit | Reference)} treeish + * @param {CheckoutOptions} [options] + * @returns {Promise} + * + * @memberof Checkout + */ static tree(repo: Repository, treeish: Oid | Tree | Commit | Reference, options?: CheckoutOptions): Promise; }