Documentation and made Option values optional

types/nodegit/blame-options.d.ts

@@ -7,47 +7,47 @@ export class BlameOptions {
      * @type {number}
      * @memberof BlameOptions
      */
-    version: number;
+    version?: number;
     /**
      *
      *
      * @type {number}
      * @memberof BlameOptions
      */
-    flags: number;
+    flags?: number;
     /**
      *
      *
      * @type {number}
      * @memberof BlameOptions
      */
-    minMatchCharacters: number;
+    minMatchCharacters?: number;
     /**
      *
      *
      * @type {Oid}
      * @memberof BlameOptions
      */
-    newestCommit: Oid;
+    newestCommit?: Oid;
     /**
      *
      *
      * @type {Oid}
      * @memberof BlameOptions
      */
-    oldestCommit: Oid;
+    oldestCommit?: Oid;
     /**
      *
      *
      * @type {number}
      * @memberof BlameOptions
      */
-    minLine: number;
+    minLine?: number;
     /**
      *
      *
      * @type {number}
      * @memberof BlameOptions
      */
-    maxLine: number;
+    maxLine?: number;
 }

types/nodegit/cherry-pick-options.d.ts

@@ -8,26 +8,26 @@ export interface CherrypickOptions {
      * @type {number}
      * @memberof CherrypickOptions
      */
-    version: number;
+    version?: number;
     /**
      *
      *
      * @type {number}
      * @memberof CherrypickOptions
      */
-    mainline: number;
+    mainline?: number;
     /**
      *
      *
      * @type {MergeOptions}
      * @memberof CherrypickOptions
      */
-    mergeOpts: MergeOptions;
+    mergeOpts?: MergeOptions;
     /**
      *
      *
      * @type {CheckoutOptions}
      * @memberof CherrypickOptions
      */
-    checkoutOpts: CheckoutOptions;
+    checkoutOpts?: CheckoutOptions;
 }

types/nodegit/describe-format-options.d.ts

@@ -5,26 +5,26 @@ export class DescribeFormatOptions {
      * @type {number}
      * @memberof DescribeFormatOptions
      */
-    version: number;
+    version?: number;
     /**
      *
      *
      * @type {number}
      * @memberof DescribeFormatOptions
      */
-    abbreviatedSize: number;
+    abbreviatedSize?: number;
     /**
      *
      *
      * @type {number}
      * @memberof DescribeFormatOptions
      */
-    alwaysUseLongFormat: number;
+    alwaysUseLongFormat?: number;
     /**
      *
      *
      * @type {string}
      * @memberof DescribeFormatOptions
      */
-    dirtySuffix: string;
+    dirtySuffix?: string;
 }

types/nodegit/describe-options.d.ts

@@ -5,40 +5,40 @@ export class DescribeOptions {
      * @type {number}
      * @memberof DescribeOptions
      */
-    version: number;
+    version?: number;
     /**
      *
      *
      * @type {number}
      * @memberof DescribeOptions
      */
-    maxCandidatesTags: number;
+    maxCandidatesTags?: number;
     /**
      *
      *
      * @type {number}
      * @memberof DescribeOptions
      */
-    describeStrategy: number;
+    describeStrategy?: number;
     /**
      *
      *
      * @type {string}
      * @memberof DescribeOptions
      */
-    pattern: string;
+    pattern?: string;
     /**
      *
      *
      * @type {number}
      * @memberof DescribeOptions
      */
-    onlyFollowFirstParent: number;
+    onlyFollowFirstParent?: number;
     /**
      *
      *
      * @type {number}
      * @memberof DescribeOptions
      */
-    showCommitOidAsFallback: number;
+    showCommitOidAsFallback?: number;
 }

types/nodegit/odb.d.ts

@@ -11,11 +11,61 @@ export namespace Odb {
 }
 
 export class Odb {
+    /**
+     *
+     *
+     * @static
+     * @param {string} objectsDir
+     * @returns {Promise<Odb>}
+     *
+     * @memberof Odb
+     */
     static open(objectsDir: string): Promise<Odb>;
 
+    /**
+     *
+     *
+     * @param {string} path
+     * @returns {number}
+     *
+     * @memberof Odb
+     */
     addDiskAlternate(path: string): number;
+    /**
+     *
+     *
+     *
+     * @memberof Odb
+     */
     free(): void;
+    /**
+     *
+     *
+     * @param {Oid} id
+     * @returns {Promise<OdbObject>}
+     *
+     * @memberof Odb
+     */
     read(id: Oid): Promise<OdbObject>;
+    /**
+     *
+     *
+     * @param {Buffer} data
+     * @param {number} len
+     * @param {number} type
+     * @returns {Promise<Oid>}
+     *
+     * @memberof Odb
+     */
     write(data: Buffer, len: number, type: number): Promise<Oid>;
+    /**
+     *
+     *
+     * @param {OdbExpandId} ids
+     * @param {number} count
+     * @returns {number}
+     *
+     * @memberof Odb
+     */
     expandIds(ids: OdbExpandId, count: number): number;
 }

types/nodegit/oid-array.d.ts

@@ -1,7 +1,25 @@
 import { Oid } from './oid';
 
 export class Oidarray {
+    /**
+     *
+     *
+     *
+     * @memberof Oidarray
+     */
     free(): void;
+    /**
+     *
+     *
+     * @type {Oid}
+     * @memberof Oidarray
+     */
     ids: Oid;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof Oidarray
+     */
     count: number;
 }

types/nodegit/oid.d.ts

@@ -1,11 +1,73 @@
 export class Oid {
     static fromString(str: string): Oid;
+    /**
+     *
+     *
+     * @param {Oid} b
+     * @returns {number}
+     *
+     * @memberof Oid
+     */
     cmp(b: Oid): number;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Oid
+     */
     cpy(): Oid;
+    /**
+     *
+     *
+     * @param {Oid} b
+     * @returns {number}
+     *
+     * @memberof Oid
+     */
     equal(b: Oid): number;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Oid
+     */
     iszero(): number;
+    /**
+     *
+     *
+     * @param {Oid} b
+     * @param {number} len
+     * @returns {number}
+     *
+     * @memberof Oid
+     */
     ncmp(b: Oid, len: number): number;
+    /**
+     *
+     *
+     * @param {string} str
+     * @returns {number}
+     *
+     * @memberof Oid
+     */
     strcmp(str: string): number;
+    /**
+     *
+     *
+     * @param {string} str
+     * @returns {number}
+     *
+     * @memberof Oid
+     */
     streq(str: string): number;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Oid
+     */
     tostrS(): string;
 }

types/nodegit/open-ssl.d.ts

@@ -1,3 +1,11 @@
 export class Openssl {
+    /**
+     *
+     *
+     * @static
+     * @returns {number}
+     *
+     * @memberof Openssl
+     */
     static setLocking(): number;
 }

types/nodegit/push-options.d.ts

@@ -1,7 +1,7 @@
 import { RemoteCallbacks } from './remote-callbacks';
 
 export interface PushOptions {
-    version: number;
-    pbParallelism: number;
-    callbacks: RemoteCallbacks;
+    version?: number;
+    pbParallelism?: number;
+    callbacks?: RemoteCallbacks;
 }

types/nodegit/status-options.d.ts

@@ -1,8 +1,8 @@
 import { Strarray } from './str-array';
 
 export interface StatusOptions {
-    version: number;
-    show: number;
-    flags: number;
-    pathspec: Strarray;
+    version?: number;
+    show?: number;
+    flags?: number;
+    pathspec?: Strarray;
 }

types/nodegit/submodule-update-options.d.ts

@@ -2,8 +2,8 @@ import { CheckoutOptions } from './checkout-options';
 import { FetchOptions } from './fetch-options';
 
 export interface SubmoduleUpdateOptions {
-    version: number;
-    checkoutOpts: CheckoutOptions;
-    fetchOpts: FetchOptions;
-    cloneCheckoutStrategy: number;
+    version?: number;
+    checkoutOpts?: CheckoutOptions;
+    fetchOpts?: FetchOptions;
+    cloneCheckoutStrategy?: number;
 }