From 93a3dc1f476028e223920a32917c5a820e3feeae Mon Sep 17 00:00:00 2001 From: Dolan Date: Fri, 9 Jun 2017 01:41:43 +0100 Subject: [PATCH] Documentation and made Option values optional --- types/nodegit/blame-options.d.ts | 14 ++--- types/nodegit/cherry-pick-options.d.ts | 8 +-- types/nodegit/describe-format-options.d.ts | 8 +-- types/nodegit/describe-options.d.ts | 12 ++-- types/nodegit/odb.d.ts | 50 +++++++++++++++++ types/nodegit/oid-array.d.ts | 18 ++++++ types/nodegit/oid.d.ts | 62 +++++++++++++++++++++ types/nodegit/open-ssl.d.ts | 8 +++ types/nodegit/push-options.d.ts | 6 +- types/nodegit/status-options.d.ts | 8 +-- types/nodegit/submodule-update-options.d.ts | 8 +-- 11 files changed, 170 insertions(+), 32 deletions(-) diff --git a/types/nodegit/blame-options.d.ts b/types/nodegit/blame-options.d.ts index eac4c2f4f0..fdebbeff67 100644 --- a/types/nodegit/blame-options.d.ts +++ b/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; } diff --git a/types/nodegit/cherry-pick-options.d.ts b/types/nodegit/cherry-pick-options.d.ts index 8743217b47..5e91da0c55 100644 --- a/types/nodegit/cherry-pick-options.d.ts +++ b/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; } diff --git a/types/nodegit/describe-format-options.d.ts b/types/nodegit/describe-format-options.d.ts index 4a67cd9082..3f1989f0dd 100644 --- a/types/nodegit/describe-format-options.d.ts +++ b/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; } diff --git a/types/nodegit/describe-options.d.ts b/types/nodegit/describe-options.d.ts index f860bb88e9..1a7518cd76 100644 --- a/types/nodegit/describe-options.d.ts +++ b/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; } diff --git a/types/nodegit/odb.d.ts b/types/nodegit/odb.d.ts index efc4fcbe13..549bba872e 100644 --- a/types/nodegit/odb.d.ts +++ b/types/nodegit/odb.d.ts @@ -11,11 +11,61 @@ export namespace Odb { } export class Odb { + /** + * + * + * @static + * @param {string} objectsDir + * @returns {Promise} + * + * @memberof Odb + */ static open(objectsDir: string): Promise; + /** + * + * + * @param {string} path + * @returns {number} + * + * @memberof Odb + */ addDiskAlternate(path: string): number; + /** + * + * + * + * @memberof Odb + */ free(): void; + /** + * + * + * @param {Oid} id + * @returns {Promise} + * + * @memberof Odb + */ read(id: Oid): Promise; + /** + * + * + * @param {Buffer} data + * @param {number} len + * @param {number} type + * @returns {Promise} + * + * @memberof Odb + */ write(data: Buffer, len: number, type: number): Promise; + /** + * + * + * @param {OdbExpandId} ids + * @param {number} count + * @returns {number} + * + * @memberof Odb + */ expandIds(ids: OdbExpandId, count: number): number; } diff --git a/types/nodegit/oid-array.d.ts b/types/nodegit/oid-array.d.ts index 7a96f24a7a..0b95d31a5d 100644 --- a/types/nodegit/oid-array.d.ts +++ b/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; } diff --git a/types/nodegit/oid.d.ts b/types/nodegit/oid.d.ts index 2aa65905f6..412a931f00 100644 --- a/types/nodegit/oid.d.ts +++ b/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; } diff --git a/types/nodegit/open-ssl.d.ts b/types/nodegit/open-ssl.d.ts index f8370260d5..4b604a6f43 100644 --- a/types/nodegit/open-ssl.d.ts +++ b/types/nodegit/open-ssl.d.ts @@ -1,3 +1,11 @@ export class Openssl { + /** + * + * + * @static + * @returns {number} + * + * @memberof Openssl + */ static setLocking(): number; } diff --git a/types/nodegit/push-options.d.ts b/types/nodegit/push-options.d.ts index 5187548b8f..693a310ed0 100644 --- a/types/nodegit/push-options.d.ts +++ b/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; } diff --git a/types/nodegit/status-options.d.ts b/types/nodegit/status-options.d.ts index c4296a5b92..9f75bbe96d 100644 --- a/types/nodegit/status-options.d.ts +++ b/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; } diff --git a/types/nodegit/submodule-update-options.d.ts b/types/nodegit/submodule-update-options.d.ts index 35bbd6b3f8..d96320204b 100644 --- a/types/nodegit/submodule-update-options.d.ts +++ b/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; }