diff --git a/types/nodegit/annotated-commit.d.ts b/types/nodegit/annotated-commit.d.ts index 0fb5465647..2cfa461958 100644 --- a/types/nodegit/annotated-commit.d.ts +++ b/types/nodegit/annotated-commit.d.ts @@ -4,35 +4,16 @@ import { Reference } from './reference'; export class AnnotatedCommit { /** - * - * - * @static - * @param {Repository} repo - repository that contains the given commit - * @param {string} branchName - name of the (remote) branch - * @param {string} remoteUrl - url of the remote - * @param {Oid} id - the commit object id of the remote branch - * @returns {Promise} - * - * @memberof AnnotatedCommit + * @param repo - repository that contains the given commit + * @param branchName - name of the (remote) branch + * @param remoteUrl - url of the remote + * @param id - the commit object id of the remote branch */ static fromFetchhead(repo: Repository, branchName: string, remoteUrl: string, id: Oid): Promise; static fromRef(repo: Repository, ref: Reference): Promise; static fromRevspec(repo: Repository, revspec: string): Promise; static lookup(repo: Repository, id: Oid): Promise; - /** - * - * - * - * @memberof AnnotatedCommit - */ free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof AnnotatedCommit - */ id(): Oid; } diff --git a/types/nodegit/attr.d.ts b/types/nodegit/attr.d.ts index c7b2d3ea22..a9c51ae8e2 100644 --- a/types/nodegit/attr.d.ts +++ b/types/nodegit/attr.d.ts @@ -10,64 +10,29 @@ export namespace Attr { } export class Attr { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} values - * @returns {number} - * - * @memberof Attr - */ static addMacro(repo: Repository, name: string, values: string): number; - /** - * - * - * @static - * @param {Repository} repo - * - * @memberof Attr - */ static cacheFlush(repo: Repository): void; /** - * - * - * @static - * @param {Repository} repo - The repository containing the path. - * @param {number} flags - A combination of GIT_ATTR_CHECK... flags. - * @param {string} path - The path to check for attributes. Relative paths are interpreted relative to the repo root. + * @param repo - The repository containing the path. + * @param flags - A combination of GIT_ATTR_CHECK... flags. + * @param path - The path to check for attributes. Relative paths are interpreted relative to the repo root. * The file does not have to exist, but if it does not, then it will be treated as a plain file (not a directory). - * @param {string} name - The name of the attribute to look up. - * @returns {Promise} - Output of the value of the attribute. Use the GIT_ATTR_... - * - * @memberof Attr + * @param name - The name of the attribute to look up. + * @returns - Output of the value of the attribute. Use the GIT_ATTR_... */ static get(repo: Repository, flags: number, path: string, name: string): Promise; /** - * - * - * @static - * @param {Repository} repo - The repository containing the path. - * @param {number} flags - A combination of GIT_ATTR_CHECK... flags. - * @param {string} path - The path to check for attributes. Relative paths are interpreted relative to the repo root. + * @param repo - The repository containing the path. + * @param flags - A combination of GIT_ATTR_CHECK... flags. + * @param path - The path to check for attributes. Relative paths are interpreted relative to the repo root. * The file does not have to exist, but if it does not, then it will be treated as a plain file (not a directory). - * @param {number} numAttr - The number of attributes being looked up - * @param {string} names - An array of num_attr strings containing attribute names. - * @returns {any[]} - * - * @memberof Attr + * @param numAttr - The number of attributes being looked up + * @param names - An array of num_attr strings containing attribute names. */ static getMany(repo: Repository, flags: number, path: string, numAttr: number, names: string): any[]; /** - * - * - * @static - * @param {string} attr - The attribute - * @returns {number}- the value type for the attribute - * - * @memberof Attr + * @param attr - The attribute + * @returns - the value type for the attribute */ static value(attr: string): number; } diff --git a/types/nodegit/blame-hunk.d.ts b/types/nodegit/blame-hunk.d.ts index 83dd1cc410..58ab8e7191 100644 --- a/types/nodegit/blame-hunk.d.ts +++ b/types/nodegit/blame-hunk.d.ts @@ -2,60 +2,12 @@ import { Oid } from './oid'; import { Signature } from './signature'; export class BlameHunk { - /** - * - * - * @type {number} - * @memberof BlameHunk - */ linesInHunk: number; - /** - * - * - * @type {Oid} - * @memberof BlameHunk - */ finalCommitId: Oid; - /** - * - * - * @type {number} - * @memberof BlameHunk - */ finalStartLineNumber: number; - /** - * - * - * @type {Signature} - * @memberof BlameHunk - */ finalSignature: Signature; - /** - * - * - * @type {Oid} - * @memberof BlameHunk - */ origCommitId: Oid; - /** - * - * - * @type {string} - * @memberof BlameHunk - */ origPath: string; - /** - * - * - * @type {number} - * @memberof BlameHunk - */ origStartLineNumber: number; - /** - * - * - * @type {Signature} - * @memberof BlameHunk - */ origSignature: Signature; } diff --git a/types/nodegit/blame-options.d.ts b/types/nodegit/blame-options.d.ts index 3505e7cf0a..6452eb08cb 100644 --- a/types/nodegit/blame-options.d.ts +++ b/types/nodegit/blame-options.d.ts @@ -1,53 +1,11 @@ import { Oid } from './oid'; export class BlameOptions { - /** - * - * - * @type {number} - * @memberof BlameOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof BlameOptions - */ flags?: number; - /** - * - * - * @type {number} - * @memberof BlameOptions - */ minMatchCharacters?: number; - /** - * - * - * @type {Oid} - * @memberof BlameOptions - */ newestCommit?: Oid; - /** - * - * - * @type {Oid} - * @memberof BlameOptions - */ oldestCommit?: Oid; - /** - * - * - * @type {number} - * @memberof BlameOptions - */ minLine?: number; - /** - * - * - * @type {number} - * @memberof BlameOptions - */ maxLine?: number; } diff --git a/types/nodegit/blame.d.ts b/types/nodegit/blame.d.ts index 79fc6a85b4..f88dda9477 100644 --- a/types/nodegit/blame.d.ts +++ b/types/nodegit/blame.d.ts @@ -17,68 +17,28 @@ export class Blame { /** * Retrieve the blame of a file * - * @static - * @param {Repository} repo - Repository that contains the file - * @param {string} path - to the file to get the blame of - * @param {BlameOptions} [options] - Options for the blame - * @returns {Blame} - * - * @memberof Blame + * @param repo - Repository that contains the file + * @param path - to the file to get the blame of + * @param [options] - Options for the blame */ static file(repo: Repository, path: string, options?: BlameOptions): Blame; /** - * - * - * @static - * @param {BlameOptions} opts - The git_blame_options struct to initialize - * @param {number} version - Version of struct; pass GIT_BLAME_OPTIONS_VERSION - * @returns {number} - * - * @memberof Blame + * @param opts - The git_blame_options struct to initialize + * @param version - Version of struct; pass GIT_BLAME_OPTIONS_VERSION */ static initOptions(opts: BlameOptions, version: number): number; - /** - * - * - * @param {string} buffer - * @param {number} bufferLen - * @returns {Promise} - * - * @memberof Blame - */ buffer(buffer: string, bufferLen: number): Promise; - /** - * - * - * - * @memberof Blame - */ + free(): void; /** - * - * - * @param {number} index - * @returns {BlameHunk} - the hunk at the given index, or NULL on error - * - * @memberof Blame + * @returns - the hunk at the given index, or NULL on error */ getHunkByIndex(index: number): BlameHunk; /** - * - * - * @param {number} lineNo - * @returns {BlameHunk} - the hunk that contains the given line, or NULL on error - * - * @memberof Blame + * @returns - the hunk that contains the given line, or NULL on error */ getHunkByLine(lineNo: number): BlameHunk; - /** - * - * - * @returns {number} - * - * @memberof Blame - */ + getHunkCount(): number; } diff --git a/types/nodegit/blob.d.ts b/types/nodegit/blob.d.ts index edd0eb62f7..9d7320c935 100644 --- a/types/nodegit/blob.d.ts +++ b/types/nodegit/blob.d.ts @@ -5,153 +5,37 @@ import { Oid } from './oid'; export class Blob { /** - * - * - * @static - * @param {Repository} repo - repository where to blob will be written - * @param {Buffer} buffer - data to be written into the blob - * @param {number} len - length of the data - * @returns {Oid} - return the id of the written blob - * - * @memberof Blob + * @param repo - repository where to blob will be written + * @param buffer - data to be written into the blob + * @param len - length of the data + * @returns - return the id of the written blob */ static createFromBuffer(repo: Repository, buffer: Buffer, len: number): Oid; /** - * - * - * @static - * @param {Oid} id - return the id of the written blob - * @param {Repository} repo - repository where the blob will be written. this repository can be bare or not - * @param {string} path - file from which the blob will be created - * @returns {number} - * - * @memberof Blob + * @param id - return the id of the written blob + * @param repo - repository where the blob will be written. this repository can be bare or not + * @param path - file from which the blob will be created */ static createFromDisk(id: Oid, repo: Repository, path: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} hintPath - * @returns {Promise} - * - * @memberof Blob - */ static createFromStream(repo: Repository, hintPath: string): Promise; /** - * - * - * @static - * @param {Oid} id - return the id of the written blob - * @param {Repository} repo - repository where the blob will be written. this repository cannot be bare - * @param {string} relativePath - file from which the blob will be created, relative to the repository's working dir - * @returns {number} - 0 or an error code - * - * @memberof Blob + * @param id - return the id of the written blob + * @param repo - repository where the blob will be written. this repository cannot be bare + * @param relativePath - file from which the blob will be created, relative to the repository's working dir + * @returns - 0 or an error code */ static createFromWorkdir(id: Oid, repo: Repository, relativePath: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {(string | Oid | Blob)} id - * @returns {Promise} - * - * @memberof Blob - */ static lookup(repo: Repository, id: string | Oid | Blob): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} id - * @param {number} len - * @returns {Promise} - * - * @memberof Blob - */ static lookupPrefix(repo: Repository, id: Oid, len: number): Promise; - /** - * - * - * - * @memberof Blob - */ free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Blob - */ id(): Oid; - /** - * - * - * @returns {number} - * - * @memberof Blob - */ isBinary(): number; - /** - * - * - * @returns {Repository} - * - * @memberof Blob - */ owner(): Repository; - /** - * - * - * @returns {Buffer} - * - * @memberof Blob - */ rawcontent(): Buffer; - /** - * - * - * @returns {number} - * - * @memberof Blob - */ rawsize(): number; - /** - * - * - * @returns {Buffer} - * - * @memberof Blob - */ content(): Buffer; - /** - * - * - * @returns {string} - * - * @memberof Blob - */ toString(): string; - /** - * - * - * @returns {number} - * - * @memberof Blob - */ filemode(): number; - /** - * - * - * @returns {Promise} - * - * @memberof Blob - */ dup(): Promise; } diff --git a/types/nodegit/branch.d.ts b/types/nodegit/branch.d.ts index 47bd1ec76f..71dc35b020 100644 --- a/types/nodegit/branch.d.ts +++ b/types/nodegit/branch.d.ts @@ -12,116 +12,14 @@ export namespace Branch { } export class Branch { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} branchName - * @param {Commit} target - * @param {number} force - * @returns {Promise} - * - * @memberof Branch - */ static create(repo: Repository, branchName: string, target: Commit, force: number): Promise; - /** - * - * - * @static - * @param {Repository} repository - * @param {string} branchName - * @param {AnnotatedCommit} commit - * @param {number} force - * @returns {Reference} - * - * @memberof Branch - */ static createFromAnnotated(repository: Repository, branchName: string, commit: AnnotatedCommit, force: number): Reference; - /** - * - * - * @static - * @param {Reference} branch - * @returns {number} - * - * @memberof Branch - */ static delete(branch: Reference): number; - /** - * - * - * @static - * @param {Reference} branch - * @returns {number} - * - * @memberof Branch - */ static isHead(branch: Reference): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {number} listFlags - * @returns {Promise} - * - * @memberof Branch - */ static iteratorNew(repo: Repository, listFlags: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} branchName - * @param {Branch.BRANCH} branchType - * @returns {Promise} - * - * @memberof Branch - */ static lookup(repo: Repository, branchName: string, branchType: Branch.BRANCH): Promise; - /** - * - * - * @static - * @param {Reference} branch - * @param {string} newBranchName - * @param {number} force - * @returns {Promise} - * - * @memberof Branch - */ static move(branch: Reference, newBranchName: string, force: number): Promise; - /** - * - * - * @static - * @param {Reference} ref - * @returns {Promise} - * - * @memberof Branch - */ static name(ref: Reference): Promise; - /** - * - * - * @static - * @param {Reference} branch - * @param {string} upstreamName - * @returns {Promise} - * - * @memberof Branch - */ static setUpstream(branch: Reference, upstreamName: string): Promise; - /** - * - * - * @static - * @param {Reference} branch - * @returns {Promise} - * - * @memberof Branch - */ static upstream(branch: Reference): Promise; } diff --git a/types/nodegit/buf.d.ts b/types/nodegit/buf.d.ts index 380d76172b..5aefac72c8 100644 --- a/types/nodegit/buf.d.ts +++ b/types/nodegit/buf.d.ts @@ -1,67 +1,13 @@ /// export class Buf { - /** - * - * - * @returns {number} - * - * @memberof Buf - */ - containsNul(): number; - /** - * - * - * - * @memberof Buf - */ - free(): void; - /** - * - * - * @param {number} targetSize - * @returns {Promise} - * - * @memberof Buf - */ - grow(targetSize: number): Promise; - /** - * - * - * @returns {number} - * - * @memberof Buf - */ - isBinary(): number; - /** - * - * - * @param {Buffer} data - * @param {number} datalen - * @returns {Promise} - * - * @memberof Buf - */ - set(data: Buffer, datalen: number): Promise; - /** - * - * - * @type {string} - * @memberof Buf - */ - ptr: string; - /** - * - * - * @type {number} - * @memberof Buf - */ - asize: number; - /** - * - * - * @type {number} - * @memberof Buf - */ - size: number; - } + containsNul(): number; + + free(): void; + grow(targetSize: number): Promise; + isBinary(): number; + set(data: Buffer, datalen: number): Promise; + ptr: string; + asize: number; + size: number; +} diff --git a/types/nodegit/cert-host-key.d.ts b/types/nodegit/cert-host-key.d.ts index f69210ca37..9932f66693 100644 --- a/types/nodegit/cert-host-key.d.ts +++ b/types/nodegit/cert-host-key.d.ts @@ -1,26 +1,8 @@ import { Cert } from './cert'; export class CertHostkey { - /** - * - * - * @type {Cert} - * @memberof CertHostkey - */ parent: Cert; type: Cert.TYPE; - /** - * - * - * @type {string} - * @memberof CertHostkey - */ hashMd5: string; - /** - * - * - * @type {string} - * @memberof CertHostkey - */ hashSha1: string; } diff --git a/types/nodegit/cert-x509.d.ts b/types/nodegit/cert-x509.d.ts index dd395a755d..44f6d5a7ae 100644 --- a/types/nodegit/cert-x509.d.ts +++ b/types/nodegit/cert-x509.d.ts @@ -1,25 +1,7 @@ import { Cert } from './cert'; export class CertX509 { - /** - * - * - * @type {Buffer} - * @memberof CertX509 - */ data: Buffer; - /** - * - * - * @type {number} - * @memberof CertX509 - */ len: number; - /** - * - * - * @type {Cert} - * @memberof CertX509 - */ parent: Cert; } diff --git a/types/nodegit/cert.d.ts b/types/nodegit/cert.d.ts index c368f83bb6..fde86569b9 100644 --- a/types/nodegit/cert.d.ts +++ b/types/nodegit/cert.d.ts @@ -13,11 +13,5 @@ export namespace Cert { } export class Cert { - /** - * - * - * @type {Cert.TYPE} - * @memberof Cert - */ certType: Cert.TYPE; } diff --git a/types/nodegit/checkout-options.d.ts b/types/nodegit/checkout-options.d.ts index 253755d7fb..4122dfbe28 100644 --- a/types/nodegit/checkout-options.d.ts +++ b/types/nodegit/checkout-options.d.ts @@ -3,144 +3,24 @@ import { Tree } from './tree'; import { Index } from './index'; export class CheckoutOptions { - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ checkoutStrategy?: number; - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ disableFilters?: number; - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ dirMode?: number; - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ fileMode?: number; - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ fileOpenFlags?: number; - /** - * - * - * @type {number} - * @memberof CheckoutOptions - */ notifyFlags?: number; - /** - * - * - * @type {*} - * @memberof CheckoutOptions - */ notifyCb?: any; - /** - * - * - * @type {undefined} - * @memberof CheckoutOptions - */ notifyPayload?: undefined; - /** - * - * - * @type {*} - * @memberof CheckoutOptions - */ progressCb?: any; - /** - * - * - * @type {undefined} - * @memberof CheckoutOptions - */ progressPayload?: undefined; - /** - * - * - * @type {Strarray} - * @memberof CheckoutOptions - */ paths?: Strarray; - /** - * - * - * @type {Tree} - * @memberof CheckoutOptions - */ baseline?: Tree; - /** - * - * - * @type {Index} - * @memberof CheckoutOptions - */ baselineIndex?: Index; - /** - * - * - * @type {string} - * @memberof CheckoutOptions - */ targetDirectory?: string; - /** - * - * - * @type {string} - * @memberof CheckoutOptions - */ ancestorLabel?: string; - /** - * - * - * @type {string} - * @memberof CheckoutOptions - */ ourLabel?: string; - /** - * - * - * @type {string} - * @memberof CheckoutOptions - */ theirLabel?: string; - /** - * - * - * @type {*} - * @memberof CheckoutOptions - */ perfdataCb?: any; - /** - * - * - * @type {undefined} - * @memberof CheckoutOptions - */ perfdataPayload?: undefined; } diff --git a/types/nodegit/checkout.d.ts b/types/nodegit/checkout.d.ts index a6ce5ff991..c29dd2d220 100644 --- a/types/nodegit/checkout.d.ts +++ b/types/nodegit/checkout.d.ts @@ -46,48 +46,16 @@ 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; } diff --git a/types/nodegit/cherry-pick-options.d.ts b/types/nodegit/cherry-pick-options.d.ts index 5e91da0c55..cde3c0a345 100644 --- a/types/nodegit/cherry-pick-options.d.ts +++ b/types/nodegit/cherry-pick-options.d.ts @@ -2,32 +2,8 @@ import { MergeOptions } from './merge-options'; import { CheckoutOptions } from './checkout-options'; export interface CherrypickOptions { - /** - * - * - * @type {number} - * @memberof CherrypickOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof CherrypickOptions - */ mainline?: number; - /** - * - * - * @type {MergeOptions} - * @memberof CherrypickOptions - */ mergeOpts?: MergeOptions; - /** - * - * - * @type {CheckoutOptions} - * @memberof CherrypickOptions - */ checkoutOpts?: CheckoutOptions; } diff --git a/types/nodegit/cherry-pick.d.ts b/types/nodegit/cherry-pick.d.ts index b895845301..168de79e3b 100644 --- a/types/nodegit/cherry-pick.d.ts +++ b/types/nodegit/cherry-pick.d.ts @@ -6,39 +6,11 @@ import { CherrypickOptions } from './cherry-pick-options'; export class Cherrypick { /** * Cherrypick a commit and, changing the index and working directory - * - * @static - * @param {Repository} repo - * @param {Commit} commit - * @param {CherrypickOptions} [options] - * @returns {Promise} - * - * @memberof Cherrypick */ static cherrypick(repo: Repository, commit: Commit, options?: CherrypickOptions): Promise; /** * Cherrypicks the given commit against "our" commit, producing an index that reflects the result of the cherrypick. The index is not backed by a repo. - * - * @static - * @param {Repository} repo - * @param {Commit} cherrypickCommit - * @param {Commit} ourCommit - * @param {number} mainline - * @param {MergeOptions} [mergeOptions] - * @returns {Promise} - * - * @memberof Cherrypick */ static commit(repo: Repository, cherrypickCommit: Commit, ourCommit: Commit, mainline: number, mergeOptions?: MergeOptions): Promise; - /** - * - * - * @static - * @param {CherrypickOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Cherrypick - */ static initOptions(opts: CherrypickOptions, version: number): number; } diff --git a/types/nodegit/clone-options.d.ts b/types/nodegit/clone-options.d.ts index 424a289cbe..8535b28c81 100644 --- a/types/nodegit/clone-options.d.ts +++ b/types/nodegit/clone-options.d.ts @@ -2,60 +2,12 @@ import { CheckoutOptions } from './checkout-options'; import { FetchOptions } from './fetch-options'; export class CloneOptions { - /** - * - * - * @type {number} - * @memberof CloneOptions - */ version?: number; - /** - * - * - * @type {CheckoutOptions} - * @memberof CloneOptions - */ checkoutOpts?: CheckoutOptions; - /** - * - * - * @type {FetchOptions} - * @memberof CloneOptions - */ fetchOpts?: FetchOptions; - /** - * - * - * @type {number} - * @memberof CloneOptions - */ bare?: number; - /** - * - * - * @type {number} - * @memberof CloneOptions - */ local?: number; - /** - * - * - * @type {string} - * @memberof CloneOptions - */ checkoutBranch?: string; - /** - * - * - * @type {*} - * @memberof CloneOptions - */ repositoryCbPayload?: any; - /** - * - * - * @type {*} - * @memberof CloneOptions - */ remoteCbPayload?: any; } diff --git a/types/nodegit/clone.d.ts b/types/nodegit/clone.d.ts index 7fe3b00a37..15933d4124 100644 --- a/types/nodegit/clone.d.ts +++ b/types/nodegit/clone.d.ts @@ -13,25 +13,8 @@ export namespace Clone { export class Clone { /** * Patch repository cloning to automatically coerce objects. - * - * @static - * @param {string} url - * @param {string} localPath - * @param {CloneOptions} [options] - * @returns {Promise} - * - * @memberof Clone */ static clone(url: string, localPath: string, options?: CloneOptions): Promise; - /** - * - * - * @static - * @param {CloneOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Clone - */ + static initOptions(opts: CloneOptions, version: number): number; } diff --git a/types/nodegit/commit.d.ts b/types/nodegit/commit.d.ts index 59928817a6..8a7a259cbf 100644 --- a/types/nodegit/commit.d.ts +++ b/types/nodegit/commit.d.ts @@ -10,288 +10,66 @@ import { TreeEntry } from './tree-entry'; import { Diff } from './diff'; export class Commit { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} updateRef - * @param {Signature} author - * @param {Signature} committer - * @param {string} messageEncoding - * @param {string} message - * @param {Tree} tree - * @param {number} parentCount - * @param {any[]} parents - * @returns {Oid} - * - * @memberof Commit - */ static create(repo: Repository, updateRef: string, author: Signature, committer: Signature, messageEncoding: string, message: string, tree: Tree, parentCount: number, parents: any[]): Oid; - /** - * - * - * @static - * @param {Oid} id - * @param {Repository} repo - * @param {string} updateRef - * @param {Signature} author - * @param {Signature} committer - * @param {string} messageEncoding - * @param {string} message - * @param {Tree} tree - * @param {number} parentCount - * @returns {number} - * - * @memberof Commit - */ static createV(id: Oid, repo: Repository, updateRef: string, author: Signature, committer: Signature, messageEncoding: string, message: string, tree: Tree, parentCount: number): number; /** * Retrieves the commit pointed to by the oid * - * @static - * @param {Repository} repo - * @param {(string | Oid | Commit)} id - * @returns {Promise} * - * @memberof Commit */ static lookup(repo: Repository, id: string | Oid | Commit): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} id - * @param {number} len - * @returns {Promise} - * - * @memberof Commit - */ static lookupPrefix(repo: Repository, id: Oid, len: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} commitContent - * @param {string} signature - * @param {string} signatureField - * @returns {Promise} - * - * @memberof Commit - */ static createWithSignature(repo: Repository, commitContent: string, signature: string, signatureField: string): Promise; - /** - * - * - * @param {string} updateRef - * @param {Signature} author - * @param {Signature} committer - * @param {string} messageEncoding - * @param {string} message - * @param {Tree} tree - * @returns {Oid} - * - * @memberof Commit - */ amend(updateRef: string, author: Signature, committer: Signature, messageEncoding: string, message: string, tree: Tree): Oid; - /** - * - * - * @returns {Signature} - * - * @memberof Commit - */ author(): Signature; - /** - * - * - * @returns {Signature} - * - * @memberof Commit - */ committer(): Signature; - /** - * - * - * - * @memberof Commit - */ + free(): void; - /** - * - * - * @param {string} field - * @returns {Promise} - * - * @memberof Commit - */ headerField(field: string): Promise; - /** - * - * - * @returns {Oid} - * - * @memberof Commit - */ id(): Oid; - /** - * - * - * @returns {string} - * - * @memberof Commit - */ message(): string; - /** - * - * - * @returns {string} - * - * @memberof Commit - */ messageEncoding(): string; - /** - * - * - * @returns {string} - * - * @memberof Commit - */ messageRaw(): string; - /** - * - * - * @param {number} n - * @returns {Promise} - * - * @memberof Commit - */ nthGenAncestor(n: number): Promise; - /** - * - * - * @returns {Repository} - * - * @memberof Commit - */ owner(): Repository; - /** - * - * - * @param {number} n - * @returns {Promise} - * - * @memberof Commit - */ parent(n: number): Promise; - /** - * - * - * @param {number} n - * @returns {Oid} - * - * @memberof Commit - */ parentId(n: number): Oid; - /** - * - * - * @returns {number} - * - * @memberof Commit - */ parentcount(): number; - /** - * - * - * @returns {string} - * - * @memberof Commit - */ rawHeader(): string; - /** - * - * - * @returns {string} - * - * @memberof Commit - */ summary(): string; - /** - * - * - * @returns {number} - * - * @memberof Commit - */ time(): number; - /** - * - * - * @returns {number} - * - * @memberof Commit - */ timeOffset(): number; - /** - * - * - * @param {Tree} treeOut - * @returns {number} - * - * @memberof Commit - */ tree(treeOut: Tree): number; - /** - * - * - * @returns {Oid} - * - * @memberof Commit - */ treeId(): Oid; /** * Retrieve the SHA. * - * @returns {string} * - * @memberof Commit */ sha(): string; /** * Retrieve the commit time as a unix timestamp. * - * @returns {number} * - * @memberof Commit */ timeMs(): number; /** * Retrieve the commit time as a Date object. * - * @returns {Date} * - * @memberof Commit */ date(): Date; /** * Get the tree associated with this commit. * - * @returns {Promise} * - * @memberof Commit */ getTree(): Promise; /** * Retrieve the entry represented by path for this commit. Path must be relative to repository root. * - * @param {string} path - * @returns {Promise} * - * @memberof Commit */ getEntry(path: string): Promise; /** @@ -299,71 +77,44 @@ export class Commit { * An EventEmitter is returned that will emit a "commit" event for each commit in the history, and one "end" * event when the walk is completed. Don't forget to call start() on the returned event. * - * @returns {EventEmitter} * - * @memberof Commit */ history(): EventEmitter; /** * Retrieve the commit's parents as commit objects. * - * @param {number} limit - * @param {Function} callback - * @returns {Promise} * - * @memberof Commit */ getParents(limit: number, callback: Function): Promise; /** * Retrieve the commit's parent shas. * - * @param {Function} callback - * @returns {Oid[]} * - * @memberof Commit */ parents(callback: Function): Oid[]; /** * Generate an array of diff trees showing changes between this commit and its parent(s). * - * @param {Function} callback - * @returns {Promise} * - * @memberof Commit */ getDiff(callback: Function): Promise; /** * Generate an array of diff trees showing changes between this commit and its parent(s). * - * @param {Object} options - * @param {Function} callback - * @returns {Promise} * - * @memberof Commit */ getDiffWithOptions(options: Object, callback: Function): Promise; /** * The sha of this commit * - * @returns {string} * - * @memberof Commit */ toString(): string; - /** - * - * - * @returns {Promise} - * - * @memberof Commit - */ dup(): Promise; /** * consists of a summary * - * @returns {string} * - * @memberof Commit */ body(): string; } diff --git a/types/nodegit/config.d.ts b/types/nodegit/config.d.ts index eea13c6c70..f03ea23922 100644 --- a/types/nodegit/config.d.ts +++ b/types/nodegit/config.d.ts @@ -12,80 +12,13 @@ export namespace Config { } export class Config { - /** - * - * - * @static - * @returns {Promise} - * - * @memberof Config - */ static openDefault(): Promise; - /** - * - * - * @static - * @returns {Promise} - * - * @memberof Config - */ static findProgramdata(): Promise; - /** - * - * - * @param {string} name - * @returns {Promise} - * - * @memberof Config - */ getStringBuf(name: string): Promise; - /** - * - * - * @param {string} name - * @param {number} value - * @returns {number} - * - * @memberof Config - */ setInt64(name: string, value: number): number; - /** - * - * - * @param {string} name - * @param {string} regexp - * @param {string} value - * @returns {number} - * - * @memberof Config - */ setMultivar(name: string, regexp: string, value: string): number; - /** - * - * - * @param {string} name - * @param {string} value - * @returns {Promise} - * - * @memberof Config - */ setString(name: string, value: string): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Config - */ snapshot(): Promise; - /** - * - * - * @param {*} transaction - * @returns {number} - * - * @memberof Config - */ lock(transaction: any): number; } diff --git a/types/nodegit/convenient-patch.d.ts b/types/nodegit/convenient-patch.d.ts index 5d3a9fd03f..68951ded3c 100644 --- a/types/nodegit/convenient-patch.d.ts +++ b/types/nodegit/convenient-patch.d.ts @@ -3,138 +3,70 @@ import { DiffFile } from './diff-file'; export class ConvenientPatch { /** * Old attributes of the file - * - * @returns {DiffFile} - * - * @memberof ConvenientPatch */ oldFile(): DiffFile; /** * New attributes of the file - * - * @returns {DiffFile} - * - * @memberof ConvenientPatch */ newFile(): DiffFile; /** * The number of hunks in this patch - * - * @returns {number} - * - * @memberof ConvenientPatch */ size(): number; /** * The hunks in this patch - * - * @returns {Promise} - * - * @memberof ConvenientPatch */ hunks(): Promise; /** * The status of this patch (unmodified, added, deleted) - * - * @returns {number} - * - * @memberof ConvenientPatch */ status(): number; /** * The line statistics of this patch (#contexts, #added, #deleted) - * - * @returns {*} - * - * @memberof ConvenientPatch */ lineStats(): any; /** * Is this an unmodified patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isUnmodified(): boolean; /** * Is this an added patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isAdded(): boolean; /** * Is this a deleted patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isDeleted(): boolean; /** - * Is this an modified patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch + * Is this an modified patch */ isModified(): boolean; /** * Is this a renamed patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isRenamed(): boolean; /** * Is this a copied patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isCopied(): boolean; /** * Is this an ignored patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isIgnored(): boolean; /** * Is this an untracked patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isUntracked(): boolean; /** * Is this a type change? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isTypeChange(): boolean; /** * Is this an undreadable patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isUnreadable(): boolean; /** * Is this a conflicted patch? - * - * @returns {boolean} - * - * @memberof ConvenientPatch */ isConflicted(): boolean; } diff --git a/types/nodegit/cred-user-pass-payload.d.ts b/types/nodegit/cred-user-pass-payload.d.ts index fdf65b9342..95beeb9f3a 100644 --- a/types/nodegit/cred-user-pass-payload.d.ts +++ b/types/nodegit/cred-user-pass-payload.d.ts @@ -1,16 +1,4 @@ export class CredUserpassPayload { - /** - * - * - * @type {string} - * @memberof CredUserpassPayload - */ username: string; - /** - * - * - * @type {string} - * @memberof CredUserpassPayload - */ password: string; } diff --git a/types/nodegit/cred-username.d.ts b/types/nodegit/cred-username.d.ts index 2522b3968a..d7b619eb5d 100644 --- a/types/nodegit/cred-username.d.ts +++ b/types/nodegit/cred-username.d.ts @@ -1,18 +1,6 @@ import { Cred } from './cred'; export class CredUsername { - /** - * - * - * @type {Cred} - * @memberof CredUsername - */ parent: Cred; - /** - * - * - * @type {string} - * @memberof CredUsername - */ username: string; } diff --git a/types/nodegit/cred.d.ts b/types/nodegit/cred.d.ts index d7b96c9fd8..160f62f903 100644 --- a/types/nodegit/cred.d.ts +++ b/types/nodegit/cred.d.ts @@ -11,86 +11,14 @@ export namespace Cred { } export class Cred { - /** - * - * - * @static - * @returns {Cred} - * - * @memberof Cred - */ static defaultNew(): Cred; - /** - * - * - * @static - * @param {string} username - * @returns {Cred} - * - * @memberof Cred - */ static sshKeyFromAgent(username: string): Cred; - /** - * - * - * @static - * @param {string} username - * @param {string} publicKey - * @param {string} privateKey - * @param {string} passphrase - * @returns {Promise} - * - * @memberof Cred - */ static sshKeyMemoryNew(username: string, publicKey: string, privateKey: string, passphrase: string): Promise; - /** - * - * - * @static - * @param {string} username - * @param {string} publicKey - * @param {string} privateKey - * @param {string} passphrase - * @returns {Cred} - * - * @memberof Cred - */ static sshKeyNew(username: string, publicKey: string, privateKey: string, passphrase: string): Cred; - /** - * - * - * @static - * @param {string} username - * @returns {Promise} - * - * @memberof Cred - */ static usernameNew(username: string): Promise; - /** - * - * - * @static - * @param {string} username - * @param {string} password - * @returns {Cred} - * - * @memberof Cred - */ static userpassPlaintextNew(username: string, password: string): Cred; - /** - * - * - * @returns {number} - * - * @memberof Cred - */ hasUsername(): number; - /** - * - * - * - * @memberof Cred - */ + free(): void; } diff --git a/types/nodegit/cvar-map.d.ts b/types/nodegit/cvar-map.d.ts index 2a5665dc6b..f7c4b227d0 100644 --- a/types/nodegit/cvar-map.d.ts +++ b/types/nodegit/cvar-map.d.ts @@ -1,23 +1,5 @@ export class CvarMap { - /** - * - * - * @type {number} - * @memberof CvarMap - */ cvarType: number; - /** - * - * - * @type {string} - * @memberof CvarMap - */ strMatch: string; - /** - * - * - * @type {number} - * @memberof CvarMap - */ mapValue: number; } diff --git a/types/nodegit/describe-format-options.d.ts b/types/nodegit/describe-format-options.d.ts index 3f1989f0dd..2ada190800 100644 --- a/types/nodegit/describe-format-options.d.ts +++ b/types/nodegit/describe-format-options.d.ts @@ -1,30 +1,6 @@ export class DescribeFormatOptions { - /** - * - * - * @type {number} - * @memberof DescribeFormatOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof DescribeFormatOptions - */ abbreviatedSize?: number; - /** - * - * - * @type {number} - * @memberof DescribeFormatOptions - */ alwaysUseLongFormat?: number; - /** - * - * - * @type {string} - * @memberof DescribeFormatOptions - */ dirtySuffix?: string; } diff --git a/types/nodegit/describe-options.d.ts b/types/nodegit/describe-options.d.ts index 1a7518cd76..9712228ec2 100644 --- a/types/nodegit/describe-options.d.ts +++ b/types/nodegit/describe-options.d.ts @@ -1,44 +1,8 @@ export class DescribeOptions { - /** - * - * - * @type {number} - * @memberof DescribeOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof DescribeOptions - */ maxCandidatesTags?: number; - /** - * - * - * @type {number} - * @memberof DescribeOptions - */ describeStrategy?: number; - /** - * - * - * @type {string} - * @memberof DescribeOptions - */ pattern?: string; - /** - * - * - * @type {number} - * @memberof DescribeOptions - */ onlyFollowFirstParent?: number; - /** - * - * - * @type {number} - * @memberof DescribeOptions - */ showCommitOidAsFallback?: number; } diff --git a/types/nodegit/diff-binary-file.d.ts b/types/nodegit/diff-binary-file.d.ts index 9774b99b87..46b67f406e 100644 --- a/types/nodegit/diff-binary-file.d.ts +++ b/types/nodegit/diff-binary-file.d.ts @@ -1,30 +1,6 @@ export class DiffBinaryFile { - /** - * - * - * @type {number} - * @memberof DiffBinaryFile - */ type: number; - /** - * - * - * @type {string} - * @memberof DiffBinaryFile - */ data: string; - /** - * - * - * @type {number} - * @memberof DiffBinaryFile - */ datalen: number; - /** - * - * - * @type {number} - * @memberof DiffBinaryFile - */ inflatedlen: number; } diff --git a/types/nodegit/diff-binary.d.ts b/types/nodegit/diff-binary.d.ts index f447510165..d5f7c6fd99 100644 --- a/types/nodegit/diff-binary.d.ts +++ b/types/nodegit/diff-binary.d.ts @@ -9,25 +9,7 @@ export namespace DiffBinary { } export class DiffBinary { - /** - * - * - * @type {DiffBinaryFile} - * @memberof DiffBinary - */ oldFile: DiffBinaryFile; - /** - * - * - * @type {DiffBinaryFile} - * @memberof DiffBinary - */ newFile: DiffBinaryFile; - /** - * - * - * @type {DiffBinary.DIFF_BINARY} - * @memberof DiffBinary - */ containsData: DiffBinary.DIFF_BINARY; } diff --git a/types/nodegit/diff-delta.d.ts b/types/nodegit/diff-delta.d.ts index b09226c064..c21d98f430 100644 --- a/types/nodegit/diff-delta.d.ts +++ b/types/nodegit/diff-delta.d.ts @@ -1,46 +1,10 @@ import { DiffFile } from './diff-file'; export class DiffDelta { - /** - * - * - * @type {number} - * @memberof DiffDelta - */ status: number; - /** - * - * - * @type {number} - * @memberof DiffDelta - */ flags: number; - /** - * - * - * @type {number} - * @memberof DiffDelta - */ similarity: number; - /** - * - * - * @type {number} - * @memberof DiffDelta - */ nfiles: number; - /** - * - * - * @type {DiffFile} - * @memberof DiffDelta - */ oldFile: DiffFile; - /** - * - * - * @type {DiffFile} - * @memberof DiffDelta - */ newFile: DiffFile; } diff --git a/types/nodegit/diff-file.d.ts b/types/nodegit/diff-file.d.ts index 7602f0dba9..9f418ccd16 100644 --- a/types/nodegit/diff-file.d.ts +++ b/types/nodegit/diff-file.d.ts @@ -3,42 +3,22 @@ import { Oid } from './oid'; export class DiffFile { /** * Returns the file's flags - * - * @returns {number} - * - * @memberof DiffFile */ flags(): number; /** * Returns the file's Oid - * - * @returns {Oid} - * - * @memberof DiffFile */ id(): Oid; /** * Returns the file's mode - * - * @returns {number} - * - * @memberof DiffFile */ mode(): number; /** * Returns the file's path - * - * @returns {string} - * - * @memberof DiffFile */ path(): string; /** * Returns the file's size - * - * @returns {number} - * - * @memberof DiffFile */ size(): number; } diff --git a/types/nodegit/diff-hunk.d.ts b/types/nodegit/diff-hunk.d.ts index 1a522ae8c6..14a1a9a304 100644 --- a/types/nodegit/diff-hunk.d.ts +++ b/types/nodegit/diff-hunk.d.ts @@ -1,44 +1,8 @@ export class DiffHunk { - /** - * - * - * @type {number} - * @memberof DiffHunk - */ oldStart: number; - /** - * - * - * @type {number} - * @memberof DiffHunk - */ oldLines: number; - /** - * - * - * @type {number} - * @memberof DiffHunk - */ newStart: number; - /** - * - * - * @type {number} - * @memberof DiffHunk - */ newLines: number; - /** - * - * - * @type {number} - * @memberof DiffHunk - */ headerLen: number; - /** - * - * - * @type {string} - * @memberof DiffHunk - */ header: string; } diff --git a/types/nodegit/diff-line.d.ts b/types/nodegit/diff-line.d.ts index 612041a92d..bf4ad7de91 100644 --- a/types/nodegit/diff-line.d.ts +++ b/types/nodegit/diff-line.d.ts @@ -2,59 +2,19 @@ export class DiffLine { /** * The relevant line * - * @returns {string} * - * @memberof DiffLine */ content(): string; /** * The non utf8 translated text * - * @returns {string} * - * @memberof DiffLine */ rawContent(): string; - /** - * - * - * @type {number} - * @memberof DiffLine - */ origin: number; - /** - * - * - * @type {number} - * @memberof DiffLine - */ oldLineno: number; - /** - * - * - * @type {number} - * @memberof DiffLine - */ newLineno: number; - /** - * - * - * @type {number} - * @memberof DiffLine - */ numLines: number; - /** - * - * - * @type {number} - * @memberof DiffLine - */ contentLen: number; - /** - * - * - * @type {number} - * @memberof DiffLine - */ contentOffset: number; } diff --git a/types/nodegit/diff-options.d.ts b/types/nodegit/diff-options.d.ts index c4f28f984f..06821b9608 100644 --- a/types/nodegit/diff-options.d.ts +++ b/types/nodegit/diff-options.d.ts @@ -1,95 +1,17 @@ import { Strarray } from './str-array'; export interface DiffOptions { - /** - * - * - * @type {number} - * @memberof DiffOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof DiffOptions - */ flags?: number; - /** - * - * - * @type {number} - * @memberof DiffOptions - */ ignoreSubmodules?: number; - /** - * - * - * @type {Strarray} - * @memberof DiffOptions - */ pathspec?: Strarray; - /** - * - * - * @type {Function} - * @memberof DiffOptions - */ notifyCb?: Function; - /** - * - * - * @type {number} - * @memberof DiffOptions - */ contextLines?: number; - /** - * - * - * @type {number} - * @memberof DiffOptions - */ interhunkLines?: number; - /** - * - * - * @type {number} - * @memberof DiffOptions - */ idAbbrev?: number; - /** - * - * - * @type {number} - * @memberof DiffOptions - */ maxSize?: number; - /** - * - * - * @type {string} - * @memberof DiffOptions - */ oldPrefix?: string; - /** - * - * - * @type {string} - * @memberof DiffOptions - */ newPrefix?: string; - /** - * - * - * @type {*} - * @memberof DiffOptions - */ payload?: any; - /** - * - * - * @type {*} - * @memberof DiffOptions - */ progressCb?: any; } diff --git a/types/nodegit/diff-perf-data.d.ts b/types/nodegit/diff-perf-data.d.ts index 30bae1d2c9..5dfca09670 100644 --- a/types/nodegit/diff-perf-data.d.ts +++ b/types/nodegit/diff-perf-data.d.ts @@ -1,23 +1,5 @@ export class DiffPerfdata { - /** - * - * - * @type {number} - * @memberof DiffPerfdata - */ version: number; - /** - * - * - * @type {number} - * @memberof DiffPerfdata - */ statCalls: number; - /** - * - * - * @type {number} - * @memberof DiffPerfdata - */ oidCalculations: number; } diff --git a/types/nodegit/diff.d.ts b/types/nodegit/diff.d.ts index 5c2b29a33b..6d8a161e9d 100644 --- a/types/nodegit/diff.d.ts +++ b/types/nodegit/diff.d.ts @@ -9,54 +9,12 @@ import { DiffOptions } from './diff-options'; import { Buf } from './buf'; export interface DiffFindOptions { - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ flags?: number; - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ renameThreshold?: number; - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ renameFromRewriteThreshold?: number; - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ copyThreshold?: number; - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ breakRewriteThreshold?: number; - /** - * - * - * @type {number} - * @memberof DiffFindOptions - */ renameLimit?: number; } @@ -171,167 +129,28 @@ export class Diff { /** * Directly run a diff between a blob and a buffer. * - * @static - * @param {Blob} oldBlob - * @param {string} oldAsPath - * @param {string} buffer - * @param {string} bufferAsPath - * @param {DiffOptions} opts - * @param {Function} fileCb - * @param {Function} binaryCb - * @param {Function} hunkCb - * @param {Function} lineCb - * @returns {Promise} * - * @memberof Diff */ static blobToBuffer(oldBlob: Blob, oldAsPath: string, buffer: string, bufferAsPath: string, opts: DiffOptions, fileCb: Function, binaryCb: Function, hunkCb: Function, lineCb: Function): Promise; - /** - * - * - * @static - * @param {string} content - * @param {number} contentLen - * @returns {Promise} - * - * @memberof Diff - */ static fromBuffer(content: string, contentLen: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Index} index - * @param {DiffOptions} opts - * @returns {Promise} - * - * @memberof Diff - */ static indexToWorkdir(repo: Repository, index: Index, opts: DiffOptions): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Index} oldIndex - * @param {Index} newIndex - * @param {DiffOptions} opts - * @returns {Promise} - * - * @memberof Diff - */ static indexToIndex(repo: Repository, oldIndex: Index, newIndex: Index, opts: DiffOptions): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Tree} oldTree - * @param {Index} index - * @param {DiffOptions} opts - * @returns {Promise} - * - * @memberof Diff - */ static treeToIndex(repo: Repository, oldTree: Tree, index: Index, opts: DiffOptions): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Tree} oldTree - * @param {Tree} new_tree - * @param {DiffOptions} opts - * @returns {Promise} - * - * @memberof Diff - */ static treeToTree(repo: Repository, oldTree: Tree, new_tree: Tree, opts: DiffOptions): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Tree} oldTree - * @param {DiffOptions} opts - * @returns {Promise} - * - * @memberof Diff - */ static treeToWorkdir(repo: Repository, oldTree: Tree, opts: DiffOptions): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Tree} oldTree - * @param {DiffOptions} opts - * @returns {Promise} - * - * @memberof Diff - */ static treeToWorkdirWithIndex(repo: Repository, oldTree: Tree, opts: DiffOptions): Promise; - /** - * - * - * @param {DiffFindOptions} options - * @returns {Promise} - * - * @memberof Diff - */ findSimilar(options: DiffFindOptions): Promise; - /** - * - * - * @param {number} idx - * @returns {DiffDelta} - * - * @memberof Diff - */ getDelta(idx: number): DiffDelta; - /** - * - * - * @returns {Promise} - * - * @memberof Diff - */ getPerfdata(): Promise; - /** - * - * - * @returns {number} - * - * @memberof Diff - */ numDeltas(): number; /** * Retrieve patches in this difflist * - * @returns {Promise} * - * @memberof Diff */ patches(): Promise; - /** - * - * - * @param {Diff} from - * @returns {Promise} - * - * @memberof Diff - */ merge(from: Diff): Promise; - /** - * - * - * @param {Diff.FORMAT} format - * @returns {Promise} - * - * @memberof Diff - */ toBuf(format: Diff.FORMAT): Promise; } diff --git a/types/nodegit/error.d.ts b/types/nodegit/error.d.ts index 9acf4cc2cd..c259749e8b 100644 --- a/types/nodegit/error.d.ts +++ b/types/nodegit/error.d.ts @@ -63,18 +63,6 @@ export namespace Error { } export class Error { - /** - * - * - * @type {string} - * @memberof Error - */ message: string; - /** - * - * - * @type {number} - * @memberof Error - */ klass: number; } diff --git a/types/nodegit/fetch-options.d.ts b/types/nodegit/fetch-options.d.ts index d391b8dab1..b2fd38cfbb 100644 --- a/types/nodegit/fetch-options.d.ts +++ b/types/nodegit/fetch-options.d.ts @@ -2,53 +2,11 @@ import { RemoteCallbacks } from './remote-callbacks'; import { Strarray } from './str-array'; export interface FetchOptions { - /** - * - * - * @type {number} - * @memberof FetchOptions - */ version?: number; - /** - * - * - * @type {RemoteCallbacks} - * @memberof FetchOptions - */ callbacks?: RemoteCallbacks; - /** - * - * - * @type {number} - * @memberof FetchOptions - */ prune?: number; - /** - * - * - * @type {number} - * @memberof FetchOptions - */ updateFetchhead?: number; - /** - * - * - * @type {number} - * @memberof FetchOptions - */ downloadTags?: number; - /** - * - * - * @type {Strarray} - * @memberof FetchOptions - */ customHeaders?: Strarray; - /** - * - * - * @type {*} - * @memberof FetchOptions - */ proxyOpts?: any; } diff --git a/types/nodegit/fetch.d.ts b/types/nodegit/fetch.d.ts index b777066629..db0980586f 100644 --- a/types/nodegit/fetch.d.ts +++ b/types/nodegit/fetch.d.ts @@ -9,15 +9,5 @@ export namespace Fetch { } export class Fetch { - /** - * - * - * @static - * @param {FetchOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Fetch - */ static initOptions(opts: FetchOptions, version: number): number; } diff --git a/types/nodegit/filter.d.ts b/types/nodegit/filter.d.ts index 7b73196ed0..066a51183e 100644 --- a/types/nodegit/filter.d.ts +++ b/types/nodegit/filter.d.ts @@ -19,125 +19,17 @@ export namespace Filter { } export class Filter { - /** - * - * - * @static - * @param {*} filters - * @param {string} name - * @returns {number} - * - * @memberof Filter - */ static listContains(filters: any, name: string): number; - /** - * - * - * @static - * @param {*} fl - * @returns {number} - * - * @memberof Filter - */ static listLength(fl: any): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {number} mode - * @param {number} options - * @returns {Promise} - * - * @memberof Filter - */ static listNew(repo: Repository, mode: number, options: number): Promise; - /** - * - * - * @static - * @param {*} filters - * @param {Blob} blob - * @param {WriteStream} target - * @returns {number} - * - * @memberof Filter - */ static listStreamBlob(filters: any, blob: Blob, target: WriteStream): number; - /** - * - * - * @static - * @param {*} filters - * @param {Buf} data - * @param {WriteStream} target - * @returns {number} - * - * @memberof Filter - */ static listStreamData(filters: any, data: Buf, target: WriteStream): number; - /** - * - * - * @static - * @param {*} filters - * @param {Repository} repo - * @param {string} path - * @param {WriteStream} target - * @returns {number} - * - * @memberof Filter - */ static listStreamFile(filters: any, repo: Repository, path: string, target: WriteStream): number; - /** - * - * - * @static - * @param {string} name - * @returns {number} - * - * @memberof Filter - */ static unregister(name: string): number; - /** - * - * - * @param {string} name - * @returns {Filter} - * - * @memberof Filter - */ lookup(name: string): Filter; - /** - * - * - * @param {string} name - * @param {number} priority - * @returns {number} - * - * @memberof Filter - */ register(name: string, priority: number): number; - /** - * - * - * @type {number} - * @memberof Filter - */ version: number; - /** - * - * - * @type {string} - * @memberof Filter - */ attributes: string; - /** - * - * - * @type {Function} - * @memberof Filter - */ stream: Function; } diff --git a/types/nodegit/git-err.d.ts b/types/nodegit/git-err.d.ts index 541a191e30..1ba843423b 100644 --- a/types/nodegit/git-err.d.ts +++ b/types/nodegit/git-err.d.ts @@ -1,39 +1,8 @@ import { Error } from './error'; export class Giterr { - /** - * - * - * @static - * - * @memberof Giterr - */ static errClear(): void; - /** - * - * - * @static - * @returns {Error} - * - * @memberof Giterr - */ static errLast(): Error; - /** - * - * - * @static - * - * @memberof Giterr - */ static errSetOom(): void; - /** - * - * - * @static - * @param {number} errorClass - * @param {string} string - * - * @memberof Giterr - */ static errSetString(errorClass: number, string: string): void; } diff --git a/types/nodegit/graph.d.ts b/types/nodegit/graph.d.ts index 90639a5075..d16d7b5dee 100644 --- a/types/nodegit/graph.d.ts +++ b/types/nodegit/graph.d.ts @@ -2,28 +2,6 @@ import { Repository } from './repository'; import { Oid } from './oid'; export class Graph { - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} local - * @param {Oid} upstream - * @returns {Promise} - * - * @memberof Graph - */ static aheadBehind(repo: Repository, local: Oid, upstream: Oid): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} commit - * @param {Oid} ancestor - * @returns {Promise} - * - * @memberof Graph - */ static descendantOf(repo: Repository, commit: Oid, ancestor: Oid): Promise; } diff --git a/types/nodegit/hash-sig.d.ts b/types/nodegit/hash-sig.d.ts index 86bfe5d64f..229d26d787 100644 --- a/types/nodegit/hash-sig.d.ts +++ b/types/nodegit/hash-sig.d.ts @@ -8,44 +8,10 @@ export namespace Hashsig { } export class Hashsig { - /** - * - * - * @static - * @param {string} buf - * @param {number} buflen - * @param {number} opts - * @returns {Promise} - * - * @memberof Hashsig - */ static create(buf: string, buflen: number, opts: number): Promise; - /** - * - * - * @static - * @param {string} path - * @param {number} opts - * @returns {Promise} - * - * @memberof Hashsig - */ static createFromFile(path: string, opts: number): Promise; - /** - * - * - * @param {Hashsig} b - * @returns {number} - * - * @memberof Hashsig - */ compare(b: Hashsig): number; - /** - * - * - * - * @memberof Hashsig - */ + free(): void; } diff --git a/types/nodegit/ignore.d.ts b/types/nodegit/ignore.d.ts index 017637c8d2..c38d84d1f3 100644 --- a/types/nodegit/ignore.d.ts +++ b/types/nodegit/ignore.d.ts @@ -1,36 +1,7 @@ import { Repository } from './repository'; export class Ignore { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} rules - * @returns {number} - * - * @memberof Ignore - */ static addRule(repo: Repository, rules: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @returns {number} - * - * @memberof Ignore - */ static clearInternalRules(repo: Repository): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} path - * @returns {Promise} - * - * @memberof Ignore - */ static pathIsIgnored(repo: Repository, path: string): Promise; } diff --git a/types/nodegit/index-entry.d.ts b/types/nodegit/index-entry.d.ts index df42f9cbce..b121b7a826 100644 --- a/types/nodegit/index-entry.d.ts +++ b/types/nodegit/index-entry.d.ts @@ -1,105 +1,21 @@ import { Oid } from './oid'; export interface IndexTime { - /** - * - * - * @type {number} - * @memberof IndexTime - */ seconds: number; - /** - * - * - * @type {number} - * @memberof IndexTime - */ nanoseconds: number; } export class IndexEntry { - /** - * - * - * @type {IndexTime} - * @memberof IndexEntry - */ ctime: IndexTime; - /** - * - * - * @type {IndexTime} - * @memberof IndexEntry - */ mtime: IndexTime; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ dev: number; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ ino: number; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ mode: number; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ uid: number; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ gid: number; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ fileSize: number; - /** - * - * - * @type {Oid} - * @memberof IndexEntry - */ id: Oid; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ flags: number; - /** - * - * - * @type {number} - * @memberof IndexEntry - */ flagsExtended: number; - /** - * - * - * @type {string} - * @memberof IndexEntry - */ path: string; } diff --git a/types/nodegit/index_.d.ts b/types/nodegit/index_.d.ts index ebc7f692f2..e2aed770f6 100644 --- a/types/nodegit/index_.d.ts +++ b/types/nodegit/index_.d.ts @@ -21,315 +21,39 @@ export namespace Index { } export class Index { - /** - * - * - * @static - * @param {IndexEntry} entry - * @returns {number} - * - * @memberof Index - */ static entryIsConflict(entry: IndexEntry): number; - /** - * - * - * @static - * @param {IndexEntry} entry - * @returns {number} - * - * @memberof Index - */ static entryStage(entry: IndexEntry): number; - /** - * - * - * @static - * @param {string} indexPath - * @returns {Promise} - * - * @memberof Index - */ static open(indexPath: string): Promise; - /** - * - * - * @param {IndexEntry} sourceEntry - * @returns {number} - * - * @memberof Index - */ add(sourceEntry: IndexEntry): number; - /** - * - * - * @param {Strarray} pathspec - * @param {number} flags - * @param {Function} callback - * @param {void} payload - * @returns {Promise} - * - * @memberof Index - */ addAll(pathspec: Strarray, flags: number, callback: Function, payload: void): Promise; - /** - * - * - * @param {string} path - * @returns {number} - * - * @memberof Index - */ addByPath(path: string): number; - /** - * - * - * @returns {number} - * - * @memberof Index - */ caps(): number; - /** - * - * - * @returns {Oid} - * - * @memberof Index - */ checksum(): Oid; - /** - * - * - * @returns {number} - * - * @memberof Index - */ clear(): number; - /** - * - * - * @param {IndexEntry} ancestorEntry - * @param {IndexEntry} ourEntry - * @param {IndexEntry} theirEntry - * @returns {number} - * - * @memberof Index - */ conflictAdd(ancestorEntry: IndexEntry, ourEntry: IndexEntry, theirEntry: IndexEntry): number; - /** - * - * - * @returns {number} - * - * @memberof Index - */ conflictCleanup(): number; - /** - * - * - * @param {string} path - * @returns {Promise} - * - * @memberof Index - */ conflictGet(path: string): Promise; - /** - * - * - * @param {string} path - * @returns {number} - * - * @memberof Index - */ conflictRemove(path: string): number; - /** - * - * - * @returns {number} - * - * @memberof Index - */ entryCount(): number; - /** - * - * - * @param {number} n - * @returns {IndexEntry} - * - * @memberof Index - */ getByIndex(n: number): IndexEntry; - /** - * - * - * @param {string} path - * @param {number} stage - * @returns {IndexEntry} - * - * @memberof Index - */ getByPath(path: string, stage: number): IndexEntry; - /** - * - * - * @returns {number} - * - * @memberof Index - */ hasConflicts(): number; - /** - * - * - * @returns {Repository} - * - * @memberof Index - */ owner(): Repository; - /** - * - * - * @returns {string} - * - * @memberof Index - */ path(): string; - /** - * - * - * @param {number} force - * @returns {number} - * - * @memberof Index - */ read(force: number): number; - /** - * - * - * @param {Tree} tree - * @returns {number} - * - * @memberof Index - */ readTree(tree: Tree): number; - /** - * - * - * @param {string} path - * @param {number} stage - * @returns {number} - * - * @memberof Index - */ remove(path: string, stage: number): number; - /** - * - * - * @param {Strarray} pathspec - * @param {Function} callback - * @param {void} payload - * @returns {Promise} - * - * @memberof Index - */ removeAll(pathspec: Strarray, callback: Function, payload: void): Promise; - /** - * - * - * @param {string} path - * @returns {number} - * - * @memberof Index - */ removeByPath(path: string): number; - /** - * - * - * @param {string} dir - * @param {number} stage - * @returns {number} - * - * @memberof Index - */ removeDirectory(dir: string, stage: number): number; - /** - * - * - * @param {number} caps - * @returns {number} - * - * @memberof Index - */ setCaps(caps: number): number; - /** - * - * - * @param {Strarray} pathspec - * @param {Function} callback - * @param {void} payload - * @returns {Promise} - * - * @memberof Index - */ updateAll(pathspec: Strarray, callback: Function, payload: void): Promise; - /** - * - * - * @returns {number} - * - * @memberof Index - */ write(): number; - /** - * - * - * @returns {Promise} - * - * @memberof Index - */ writeTree(): Promise; - /** - * - * - * @param {Repository} repo - * @returns {Promise} - * - * @memberof Index - */ writeTreeTo(repo: Repository): Promise; - /** - * - * - * @returns {IndexEntry[]} - * - * @memberof Index - */ entries(): IndexEntry[]; - /** - * - * - * @param {number} atPos - * @param {string} prefix - * @returns {number} - * - * @memberof Index - */ findPrefix(atPos: number, prefix: string): number; - /** - * - * - * @param {number} version - * @returns {number} - * - * @memberof Index - */ setVersion(version: number): number; - /** - * - * - * @returns {number} - * - * @memberof Index - */ version(): number; } diff --git a/types/nodegit/indexer.d.ts b/types/nodegit/indexer.d.ts index e776c0f508..d4d3210bf1 100644 --- a/types/nodegit/indexer.d.ts +++ b/types/nodegit/indexer.d.ts @@ -2,28 +2,8 @@ import { TransferProgress } from './transfer-progress'; import { Oid } from './oid'; export class Indexer { - /** - * - * - * @param {TransferProgress} stats - * @returns {number} - * - * @memberof Indexer - */ commit(stats: TransferProgress): number; - /** - * - * - * - * @memberof Indexer - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Indexer - */ hash(): Oid; } diff --git a/types/nodegit/lib-git2.d.ts b/types/nodegit/lib-git2.d.ts index 10ad4f864a..be5a5d1856 100644 --- a/types/nodegit/lib-git2.d.ts +++ b/types/nodegit/lib-git2.d.ts @@ -17,52 +17,9 @@ export namespace Libgit2 { } export class Libgit2 { - /** - * - * - * @static - * @returns {number} - * - * @memberof Libgit2 - */ static features(): number; - /** - * - * - * @static - * @returns {number} - * - * @memberof Libgit2 - */ static init(): number; - /** - * - * - * @static - * @param {number} option - * @returns {number} - * - * @memberof Libgit2 - */ static opts(option: number): number; - /** - * - * - * @static - * @returns {number} - * - * @memberof Libgit2 - */ static shutdown(): number; - /** - * - * - * @static - * @param {number} major - * @param {number} minor - * @param {number} rev - * - * @memberof Libgit2 - */ static version(major: number, minor: number, rev: number): void; } diff --git a/types/nodegit/merge-file-input.d.ts b/types/nodegit/merge-file-input.d.ts index 9401f8fd1d..f49bd446ca 100644 --- a/types/nodegit/merge-file-input.d.ts +++ b/types/nodegit/merge-file-input.d.ts @@ -1,37 +1,7 @@ export interface MergeFileInput { - /** - * - * - * @type {number} - * @memberof MergeFileInput - */ version: number; - /** - * - * - * @type {string} - * @memberof MergeFileInput - */ ptr: string; - /** - * - * - * @type {number} - * @memberof MergeFileInput - */ size: number; - /** - * - * - * @type {string} - * @memberof MergeFileInput - */ path: string; - /** - * - * - * @type {number} - * @memberof MergeFileInput - */ mode: number; } diff --git a/types/nodegit/merge-file-options.d.ts b/types/nodegit/merge-file-options.d.ts index 6212c6275e..9fe6394b4e 100644 --- a/types/nodegit/merge-file-options.d.ts +++ b/types/nodegit/merge-file-options.d.ts @@ -1,44 +1,8 @@ export interface MergeFileOptions { - /** - * - * - * @type {number} - * @memberof MergeFileOptions - */ version?: number; - /** - * - * - * @type {string} - * @memberof MergeFileOptions - */ ancestorLabel?: string; - /** - * - * - * @type {string} - * @memberof MergeFileOptions - */ ourLabel?: string; - /** - * - * - * @type {string} - * @memberof MergeFileOptions - */ theirLabel?: string; - /** - * - * - * @type {number} - * @memberof MergeFileOptions - */ favor?: number; - /** - * - * - * @type {number} - * @memberof MergeFileOptions - */ flags?: number; } diff --git a/types/nodegit/merge-file-result.d.ts b/types/nodegit/merge-file-result.d.ts index da2410da01..e6f2efcc3b 100644 --- a/types/nodegit/merge-file-result.d.ts +++ b/types/nodegit/merge-file-result.d.ts @@ -1,37 +1,7 @@ export class MergeFileResult { - /** - * - * - * @type {number} - * @memberof MergeFileResult - */ automergeable: number; - /** - * - * - * @type {string} - * @memberof MergeFileResult - */ path: string; - /** - * - * - * @type {number} - * @memberof MergeFileResult - */ mode: number; - /** - * - * - * @type {string} - * @memberof MergeFileResult - */ ptr: string; - /** - * - * - * @type {number} - * @memberof MergeFileResult - */ len: number; } diff --git a/types/nodegit/merge-options.d.ts b/types/nodegit/merge-options.d.ts index 31445857dd..eb5aac909a 100644 --- a/types/nodegit/merge-options.d.ts +++ b/types/nodegit/merge-options.d.ts @@ -1,58 +1,10 @@ export class MergeOptions { - /** - * - * - * @type {number} - * @memberof MergeOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof MergeOptions - */ renameThreshold?: number; - /** - * - * - * @type {number} - * @memberof MergeOptions - */ targetLimit?: number; - /** - * - * - * @type {number} - * @memberof MergeOptions - */ fileFavor?: number; - /** - * - * - * @type {number} - * @memberof MergeOptions - */ fileFlags?: number; - /** - * - * - * @type {string} - * @memberof MergeOptions - */ defaultDriver?: string; - /** - * - * - * @type {number} - * @memberof MergeOptions - */ flags?: number; - /** - * - * - * @type {number} - * @memberof MergeOptions - */ recursionLimit?: number; } diff --git a/types/nodegit/merge.d.ts b/types/nodegit/merge.d.ts index ae4a7d053c..a7b262e61c 100644 --- a/types/nodegit/merge.d.ts +++ b/types/nodegit/merge.d.ts @@ -49,90 +49,11 @@ export namespace Merge { } export class Merge { - /** - * - * - * @static - * @param {Repository} repo - * @param {AnnotatedCommit} theirHead - * @param {MergeOptions} [mergeOpts] - * @param {CheckoutOptions} [checkoutOpts] - * @returns {*} - * - * @memberof Merge - */ static merge(repo: Repository, theirHead: AnnotatedCommit, mergeOpts?: MergeOptions, checkoutOpts?: CheckoutOptions): any; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} one - * @param {Oid} two - * @returns {Promise} - * - * @memberof Merge - */ static base(repo: Repository, one: Oid, two: Oid): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} one - * @param {Oid} two - * @returns {Promise} - * - * @memberof Merge - */ static bases(repo: Repository, one: Oid, two: Oid): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Commit} ourCommit - * @param {Commit} theirCommit - * @param {MergeOptions} [options] - * @returns {*} - * - * @memberof Merge - */ static commits(repo: Repository, ourCommit: Commit, theirCommit: Commit, options?: MergeOptions): any; - /** - * - * - * @static - * @param {MergeFileInput} opts - * @param {number} version - * @returns {number} - * - * @memberof Merge - */ static fileInitInput(opts: MergeFileInput, version: number): number; - /** - * - * - * @static - * @param {MergeOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Merge - */ static initOptions(opts: MergeOptions, version: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {Tree} ancestorTree - * @param {Tree} ourTree - * @param {Tree} theirTree - * @param {MergeOptions} opts - * @returns {Promise} - * - * @memberof Merge - */ static trees(repo: Repository, ancestorTree: Tree, ourTree: Tree, theirTree: Tree, opts: MergeOptions): Promise; } diff --git a/types/nodegit/note.d.ts b/types/nodegit/note.d.ts index c5d06f63a7..b2c196c3b7 100644 --- a/types/nodegit/note.d.ts +++ b/types/nodegit/note.d.ts @@ -3,122 +3,17 @@ import { Signature } from './signature'; import { Oid } from './oid'; export class Note { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} notesRef - * @param {Signature} author - * @param {Signature} committer - * @param {Oid} oid - * @param {string} note - * @param {number} force - * @returns {Promise} - * - * @memberof Note - */ static create(repo: Repository, notesRef: string, author: Signature, committer: Signature, oid: Oid, note: string, force: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} notesRef - * @param {Function} noteCb - * @param {*} payload - * @returns {Promise} - * - * @memberof Note - */ static foreach(repo: Repository, notesRef: string, noteCb: Function, payload: any): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} notesRef - * @returns {Promise} - * - * @memberof Note - */ static iteratorNew(repo: Repository, notesRef: string): Promise; - /** - * - * - * @static - * @param {Oid} noteId - * @param {Oid} annotatedId - * @param {*} it - * @returns {number} - * - * @memberof Note - */ static next(noteId: Oid, annotatedId: Oid, it: any): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} notesRef - * @param {Oid} oid - * @returns {Promise} - * - * @memberof Note - */ static read(repo: Repository, notesRef: string, oid: Oid): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} notesRef - * @param {Signature} author - * @param {Signature} committer - * @param {Oid} oid - * @returns {Promise} - * - * @memberof Note - */ static remove(repo: Repository, notesRef: string, author: Signature, committer: Signature, oid: Oid): Promise; - /** - * - * - * @returns {Signature} - * - * @memberof Note - */ author(): Signature; - /** - * - * - * @returns {Signature} - * - * @memberof Note - */ committer(): Signature; - /** - * - * - * - * @memberof Note - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Note - */ id(): Oid; - /** - * - * - * @returns {string} - * - * @memberof Note - */ message(): string; } diff --git a/types/nodegit/object.d.ts b/types/nodegit/object.d.ts index 747e4ffc28..4ec5a19b6c 100644 --- a/types/nodegit/object.d.ts +++ b/types/nodegit/object.d.ts @@ -3,136 +3,20 @@ import { Repository } from './repository'; import { Buf } from './buf'; export class Object { - /** - * - * - * @static - * @param {number} type - * @returns {number} - * - * @memberof Object - */ static size(type: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} id - * @param {number} type - * @returns {Promise} - * - * @memberof Object - */ static lookup(repo: Repository, id: Oid, type: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} id - * @param {number} len - * @param {number} type - * @returns {Promise} - * - * @memberof Object - */ static lookupPrefix(repo: Repository, id: Oid, len: number, type: number): Promise; - /** - * - * - * @static - * @param {string} str - * @returns {number} - * - * @memberof Object - */ static string2type(str: string): number; - /** - * - * - * @static - * @param {number} type - * @returns {string} - * - * @memberof Object - */ static type2string(type: number): string; - /** - * - * - * @static - * @param {number} type - * @returns {number} - * - * @memberof Object - */ static typeisloose(type: number): number; - /** - * - * - * @returns {Promise} - * - * @memberof Object - */ dup(): Promise; - /** - * - * - * - * @memberof Object - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Object - */ id(): Oid; - /** - * - * - * @param {string} path - * @param {number} type - * @returns {Promise} - * - * @memberof Object - */ lookupByPath(path: string, type: number): Promise; - /** - * - * - * @returns {Repository} - * - * @memberof Object - */ owner(): Repository; - /** - * - * - * @param {number} targetType - * @returns {Promise} - * - * @memberof Object - */ peel(targetType: number): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Object - */ shortId(): Promise; - /** - * - * - * @returns {number} - * - * @memberof Object - */ type(): number; } diff --git a/types/nodegit/odb-object.d.ts b/types/nodegit/odb-object.d.ts index 8b76274b00..9685f28212 100644 --- a/types/nodegit/odb-object.d.ts +++ b/types/nodegit/odb-object.d.ts @@ -1,51 +1,11 @@ import { Oid } from './oid'; export class OdbObject { - /** - * - * - * @returns {Buffer} - * - * @memberof OdbObject - */ data(): Buffer; - /** - * - * - * @returns {Promise} - * - * @memberof OdbObject - */ dup(): Promise; - /** - * - * - * - * @memberof OdbObject - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof OdbObject - */ id(): Oid; - /** - * - * - * @returns {number} - * - * @memberof OdbObject - */ size(): number; - /** - * - * - * @returns {number} - * - * @memberof OdbObject - */ type(): number; } diff --git a/types/nodegit/odb.d.ts b/types/nodegit/odb.d.ts index 549bba872e..db0aacda61 100644 --- a/types/nodegit/odb.d.ts +++ b/types/nodegit/odb.d.ts @@ -11,61 +11,12 @@ 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 0b95d31a5d..7a96f24a7a 100644 --- a/types/nodegit/oid-array.d.ts +++ b/types/nodegit/oid-array.d.ts @@ -1,25 +1,7 @@ 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 412a931f00..2aa65905f6 100644 --- a/types/nodegit/oid.d.ts +++ b/types/nodegit/oid.d.ts @@ -1,73 +1,11 @@ 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 4b604a6f43..f8370260d5 100644 --- a/types/nodegit/open-ssl.d.ts +++ b/types/nodegit/open-ssl.d.ts @@ -1,11 +1,3 @@ export class Openssl { - /** - * - * - * @static - * @returns {number} - * - * @memberof Openssl - */ static setLocking(): number; } diff --git a/types/nodegit/pack-builder.d.ts b/types/nodegit/pack-builder.d.ts index e528ccbf38..ed0fa0a2cc 100644 --- a/types/nodegit/pack-builder.d.ts +++ b/types/nodegit/pack-builder.d.ts @@ -10,102 +10,16 @@ export namespace Packbuilder { } export class Packbuilder { - /** - * - * - * @static - * @param {Repository} repo - * @returns {Packbuilder} - * - * @memberof Packbuilder - */ static create(repo: Repository): Packbuilder; - /** - * - * - * - * @memberof Packbuilder - */ free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Packbuilder - */ hash(): Oid; - /** - * - * - * @param {Oid} id - * @param {string} name - * @returns {number} - * - * @memberof Packbuilder - */ insert(id: Oid, name: string): number; - /** - * - * - * @param {Oid} id - * @returns {number} - * - * @memberof Packbuilder - */ insertCommit(id: Oid): number; - /** - * - * - * @param {Oid} id - * @param {string} name - * @returns {number} - * - * @memberof Packbuilder - */ insertRecur(id: Oid, name: string): number; - /** - * - * - * @param {Oid} id - * @returns {number} - * - * @memberof Packbuilder - */ insertTree(id: Oid): number; - /** - * - * - * @param {Revwalk} walk - * @returns {number} - * - * @memberof Packbuilder - */ insertWalk(walk: Revwalk): number; - /** - * - * - * @returns {number} - * - * @memberof Packbuilder - */ objectCount(): number; - /** - * - * - * @param {number} n - * @returns {number} - * - * @memberof Packbuilder - */ setThreads(n: number): number; - /** - * - * - * @returns {number} - * - * @memberof Packbuilder - */ written(): number; } diff --git a/types/nodegit/path-spec.d.ts b/types/nodegit/path-spec.d.ts index 0581523300..99435d5e0d 100644 --- a/types/nodegit/path-spec.d.ts +++ b/types/nodegit/path-spec.d.ts @@ -18,125 +18,17 @@ export namespace Pathspec { } export class Pathspec { - /** - * - * - * @static - * @param {*} m - * @param {number} pos - * @returns {DiffDelta} - * - * @memberof Pathspec - */ static matchListDiffEntry(m: any, pos: number): DiffDelta; - /** - * - * - * @static - * @param {*} m - * @param {number} pos - * @returns {string} - * - * @memberof Pathspec - */ static matchListEntry(m: any, pos: number): string; - /** - * - * - * @static - * @param {*} m - * @returns {number} - * - * @memberof Pathspec - */ static matchListEntrycount(m: any): number; - /** - * - * - * @static - * @param {*} m - * @param {number} pos - * @returns {string} - * - * @memberof Pathspec - */ static matchListFailedEntry(m: any, pos: number): string; - /** - * - * - * @static - * @param {*} m - * @returns {number} - * - * @memberof Pathspec - */ static matchListFailedEntrycount(m: any): number; - /** - * - * - * @static - * @param {Strarray} pathspec - * @returns {Pathspec} - * - * @memberof Pathspec - */ static create(pathspec: Strarray): Pathspec; - /** - * - * - * - * @memberof Pathspec - */ free(): void; - /** - * - * - * @param {Diff} diff - * @param {number} flags - * @returns {Promise} - * - * @memberof Pathspec - */ matchDiff(diff: Diff, flags: number): Promise; - /** - * - * - * @param {Index} index - * @param {number} flags - * @returns {Promise} - * - * @memberof Pathspec - */ matchIndex(index: Index, flags: number): Promise; - /** - * - * - * @param {Tree} tree - * @param {number} flags - * @returns {Promise} - * - * @memberof Pathspec - */ matchTree(tree: Tree, flags: number): Promise; - /** - * - * - * @param {Repository} repo - * @param {number} flags - * @returns {Promise} - * - * @memberof Pathspec - */ matchWorkdir(repo: Repository, flags: number): Promise; - /** - * - * - * @param {number} flags - * @param {string} path - * @returns {number} - * - * @memberof Pathspec - */ matchesPath(flags: number, path: string): number; } diff --git a/types/nodegit/proxy-options.d.ts b/types/nodegit/proxy-options.d.ts index 600b34cd04..19bba458cb 100644 --- a/types/nodegit/proxy-options.d.ts +++ b/types/nodegit/proxy-options.d.ts @@ -1,44 +1,8 @@ export class ProxyOptions { - /** - * - * - * @type {Function} - * @memberof ProxyOptions - */ certificateCheck?: Function; - /** - * - * - * @type {Function} - * @memberof ProxyOptions - */ credentials?: Function; - /** - * - * - * @type {*} - * @memberof ProxyOptions - */ payload?: any; - /** - * - * - * @type {number} - * @memberof ProxyOptions - */ type?: number; - /** - * - * - * @type {string} - * @memberof ProxyOptions - */ url?: string; - /** - * - * - * @type {number} - * @memberof ProxyOptions - */ version?: number; } diff --git a/types/nodegit/push-options.d.ts b/types/nodegit/push-options.d.ts index c26b663383..7c589bfb91 100644 --- a/types/nodegit/push-options.d.ts +++ b/types/nodegit/push-options.d.ts @@ -3,39 +3,9 @@ import { Strarray } from './str-array'; import { ProxyOptions } from './proxy-options'; export interface PushOptions { - /** - * - * - * @type {number} - * @memberof PushOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof PushOptions - */ pbParallelism?: number; - /** - * - * - * @type {RemoteCallbacks} - * @memberof PushOptions - */ callbacks?: RemoteCallbacks; - /** - * - * - * @type {Strarray} - * @memberof PushOptions - */ customHeaders?: Strarray; - /** - * - * - * @type {ProxyOptions} - * @memberof PushOptions - */ proxyOpts?: ProxyOptions; } diff --git a/types/nodegit/push-update.d.ts b/types/nodegit/push-update.d.ts index cdd393d9ba..50f46726d5 100644 --- a/types/nodegit/push-update.d.ts +++ b/types/nodegit/push-update.d.ts @@ -1,32 +1,8 @@ import { Oid } from './oid'; export class PushUpdate { - /** - * - * - * @type {string} - * @memberof PushUpdate - */ srcRefname: string; - /** - * - * - * @type {string} - * @memberof PushUpdate - */ dstRefname: string; - /** - * - * - * @type {Oid} - * @memberof PushUpdate - */ src: Oid; - /** - * - * - * @type {Oid} - * @memberof PushUpdate - */ dst: Oid; } diff --git a/types/nodegit/push.d.ts b/types/nodegit/push.d.ts index 4a4ce53dac..26d8f07b60 100644 --- a/types/nodegit/push.d.ts +++ b/types/nodegit/push.d.ts @@ -2,15 +2,5 @@ import { RemoteCallbacks } from './remote-callbacks'; import { PushOptions } from './push-options'; export class Push { - /** - * - * - * @static - * @param {PushOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Push - */ static initOptions(opts: PushOptions, version: number): number; } diff --git a/types/nodegit/rebase-operation.d.ts b/types/nodegit/rebase-operation.d.ts index e52542fb54..7144ebe6a9 100644 --- a/types/nodegit/rebase-operation.d.ts +++ b/types/nodegit/rebase-operation.d.ts @@ -12,25 +12,7 @@ export namespace RebaseOperation { } export class RebaseOperation { - /** - * - * - * @type {number} - * @memberof RebaseOperation - */ type: number; - /** - * - * - * @type {Oid} - * @memberof RebaseOperation - */ id: Oid; - /** - * - * - * @type {string} - * @memberof RebaseOperation - */ exec: string; } diff --git a/types/nodegit/rebase.d.ts b/types/nodegit/rebase.d.ts index e1d64ede01..383642137e 100644 --- a/types/nodegit/rebase.d.ts +++ b/types/nodegit/rebase.d.ts @@ -14,112 +14,16 @@ export interface RebaseOptions { } export class Rebase { - /** - * - * - * @static - * @param {Repository} repo - * @param {AnnotatedCommit} branch - * @param {AnnotatedCommit} upstream - * @param {AnnotatedCommit} onto - * @param {RebaseOptions} opts - * @returns {Promise} - * - * @memberof Rebase - */ static init(repo: Repository, branch: AnnotatedCommit, upstream: AnnotatedCommit, onto: AnnotatedCommit, opts: RebaseOptions): Promise; - /** - * - * - * @static - * @param {RebaseOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Rebase - */ static initOptions(opts: RebaseOptions, version: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {RebaseOptions} opts - * @returns {Promise} - * - * @memberof Rebase - */ static open(repo: Repository, opts: RebaseOptions): Promise; - /** - * - * - * @returns {number} - * - * @memberof Rebase - */ abort(): number; - /** - * - * - * @param {Signature} author - * @param {Signature} committer - * @param {string} messageEncoding - * @param {string} message - * @returns {Oid} - * - * @memberof Rebase - */ commit(author: Signature, committer: Signature, messageEncoding: string, message: string): Oid; - /** - * - * - * @param {Signature} signature - * @returns {number} - * - * @memberof Rebase - */ finish(signature: Signature): number; - /** - * - * - * @param {Index} index - * @returns {number} - * - * @memberof Rebase - */ inmemoryIndex(index: Index): number; - /** - * - * - * @returns {Promise} - * - * @memberof Rebase - */ next(): Promise; - /** - * - * - * @param {number} idx - * @returns {RebaseOperation} - * - * @memberof Rebase - */ operationByIndex(idx: number): RebaseOperation; - /** - * - * - * @returns {number} - * - * @memberof Rebase - */ operationCurrent(): number; - /** - * - * - * @returns {number} - * - * @memberof Rebase - */ operationEntrycount(): number; } diff --git a/types/nodegit/ref-db.d.ts b/types/nodegit/ref-db.d.ts index de927eec58..6a5701ff03 100644 --- a/types/nodegit/ref-db.d.ts +++ b/types/nodegit/ref-db.d.ts @@ -1,30 +1,9 @@ import { Repository } from './repository'; export class Refdb { - /** - * - * - * @static - * @param {Repository} repo - * @returns {Promise} - * - * @memberof Refdb - */ static open(repo: Repository): Promise; - /** - * - * - * @returns {number} - * - * @memberof Refdb - */ compress(): number; - /** - * - * - * - * @memberof Refdb - */ + free(): void; } diff --git a/types/nodegit/ref-log.d.ts b/types/nodegit/ref-log.d.ts index 78367ffccd..ac43de7e70 100644 --- a/types/nodegit/ref-log.d.ts +++ b/types/nodegit/ref-log.d.ts @@ -3,127 +3,22 @@ import { Oid } from './oid'; import { Signature } from './signature'; export class Reflog { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @returns {number} - * - * @memberof Reflog - */ static delete(repo: Repository, name: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @returns {Promise} - * - * @memberof Reflog - */ static read(repo: Repository, name: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} oldName - * @param {string} name - * @returns {number} - * - * @memberof Reflog - */ static rename(repo: Repository, oldName: string, name: string): number; - /** - * - * - * @param {Oid} id - * @param {Signature} committer - * @param {string} msg - * @returns {number} - * - * @memberof Reflog - */ append(id: Oid, committer: Signature, msg: string): number; - /** - * - * - * @param {number} idx - * @param {number} rewritePreviousEntry - * @returns {number} - * - * @memberof Reflog - */ drop(idx: number, rewritePreviousEntry: number): number; - /** - * - * - * @param {number} idx - * @returns {ReflogEntry} - * - * @memberof Reflog - */ entryByIndex(idx: number): ReflogEntry; - /** - * - * - * @returns {number} - * - * @memberof Reflog - */ entrycount(): number; - /** - * - * - * - * @memberof Reflog - */ + free(): void; - /** - * - * - * @returns {number} - * - * @memberof Reflog - */ write(): number; } export class ReflogEntry { - /** - * - * - * @returns {Signature} - * - * @memberof ReflogEntry - */ committer(): Signature; - /** - * - * - * @returns {Oid} - * - * @memberof ReflogEntry - */ idNew(): Oid; - /** - * - * - * @returns {Oid} - * - * @memberof ReflogEntry - */ idOld(): Oid; - /** - * - * - * @returns {string} - * - * @memberof ReflogEntry - */ message(): string; } diff --git a/types/nodegit/ref-spec.d.ts b/types/nodegit/ref-spec.d.ts index e48c8cd2ac..bf40f21ac2 100644 --- a/types/nodegit/ref-spec.d.ts +++ b/types/nodegit/ref-spec.d.ts @@ -1,52 +1,8 @@ export class Refspec { - /** - * - * - * @returns {number} - * - * @memberof Refspec - */ direction(): number; - /** - * - * - * @returns {string} - * - * @memberof Refspec - */ dst(): string; - /** - * - * - * @param {string} refname - * @returns {number} - * - * @memberof Refspec - */ dstMatches(refname: string): number; - /** - * - * - * @returns {number} - * - * @memberof Refspec - */ force(): number; - /** - * - * - * @returns {string} - * - * @memberof Refspec - */ src(): string; - /** - * - * - * @param {string} refname - * @returns {number} - * - * @memberof Refspec - */ srcMatches(refname: string): number; } diff --git a/types/nodegit/reference.d.ts b/types/nodegit/reference.d.ts index cb449ee225..10b21a0add 100644 --- a/types/nodegit/reference.d.ts +++ b/types/nodegit/reference.d.ts @@ -19,365 +19,42 @@ export namespace Reference { } export class Reference { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {Oid} id - * @param {number} force - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ static create(repo: Repository, name: string, id: Oid, force: number, logMessage: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {Oid} id - * @param {number} force - * @param {Oid} currentId - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ static createMatching(repo: Repository, name: string, id: Oid, force: number, currentId: Oid, logMessage: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {(string | Reference)} id - * @param {Function} callback - * @returns {Promise} - * - * @memberof Reference - */ static dwim(repo: Repository, id: string | Reference, callback: Function): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} refname - * @returns {number} - * - * @memberof Reference - */ static ensureLog(repo: Repository, refname: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} refname - * @returns {number} - * - * @memberof Reference - */ static hasLog(repo: Repository, refname: string): number; - /** - * - * - * @static - * @param {string} refname - * @returns {number} - * - * @memberof Reference - */ static isValidName(refname: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @returns {Promise} - * - * @memberof Reference - */ static list(repo: Repository): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {(string | Reference)} id - * @param {Function} callback - * @returns {Promise} - * - * @memberof Reference - */ static lookup(repo: Repository, id: string | Reference, callback: Function): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @returns {Promise} - * - * @memberof Reference - */ static nameToId(repo: Repository, name: string): Promise; - /** - * - * - * @static - * @param {string} bufferOut - * @param {number} bufferSize - * @param {string} name - * @param {number} flags - * @returns {number} - * - * @memberof Reference - */ static normalizeName(bufferOut: string, bufferSize: number, name: string, flags: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @returns {number} - * - * @memberof Reference - */ static remove(repo: Repository, name: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} target - * @param {number} force - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ static symbolicCreate(repo: Repository, name: string, target: string, force: number, logMessage: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} target - * @param {number} force - * @param {string} currentValue - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ static symbolicCreateMatching(repo: Repository, name: string, target: string, force: number, currentValue: string, logMessage: string): Promise; - /** - * - * - * @param {Reference} ref2 - * @returns {number} - * - * @memberof Reference - */ cmp(ref2: Reference): number; - /** - * - * - * @returns {number} - * - * @memberof Reference - */ delete(): number; - /** - * - * - * @returns {number} - * - * @memberof Reference - */ isBranch(): number; - /** - * - * - * @returns {number} - * - * @memberof Reference - */ isNote(): number; - /** - * - * - * @returns {number} - * - * @memberof Reference - */ isRemote(): number; - /** - * - * - * @returns {number} - * - * @memberof Reference - */ isTag(): number; - /** - * - * - * @returns {string} - * - * @memberof Reference - */ name(): string; - /** - * - * - * @returns {Repository} - * - * @memberof Reference - */ owner(): Repository; - /** - * - * - * @param {number} type - * @returns {Promise} - * - * @memberof Reference - */ peel(type: number): Promise; - /** - * - * - * @param {string} newName - * @param {number} force - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ rename(newName: string, force: number, logMessage: string): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Reference - */ resolve(): Promise; - /** - * - * - * @param {Oid} id - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ setTarget(id: Oid, logMessage: string): Promise; - /** - * - * - * @returns {string} - * - * @memberof Reference - */ shorthand(): string; - /** - * - * - * @param {string} target - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Reference - */ symbolicSetTarget(target: string, logMessage: string): Promise; - /** - * - * - * @returns {string} - * - * @memberof Reference - */ symbolicTarget(): string; - /** - * - * - * @returns {Oid} - * - * @memberof Reference - */ target(): Oid; - /** - * - * - * @returns {Oid} - * - * @memberof Reference - */ targetPeel(): Oid; - /** - * - * - * @returns {number} - * - * @memberof Reference - */ type(): number; - /** - * - * - * @returns {boolean} - * - * @memberof Reference - */ isValid(): boolean; - /** - * - * - * @returns {boolean} - * - * @memberof Reference - */ isConcrete(): boolean; - /** - * - * - * @returns {boolean} - * - * @memberof Reference - */ isSymbolic(): boolean; - /** - * - * - * @returns {string} - * - * @memberof Reference - */ toString(): string; - /** - * - * - * @returns {boolean} - * - * @memberof Reference - */ isHead(): boolean; - /** - * - * - * @returns {Promise} - * - * @memberof Reference - */ dup(): Promise; } diff --git a/types/nodegit/remote-callbacks.d.ts b/types/nodegit/remote-callbacks.d.ts index b3cf3d9054..ca244e5c5e 100644 --- a/types/nodegit/remote-callbacks.d.ts +++ b/types/nodegit/remote-callbacks.d.ts @@ -1,44 +1,8 @@ export class RemoteCallbacks { - /** - * - * - * @type {number} - * @memberof RemoteCallbacks - */ version?: number; - /** - * - * - * @type {Function} - * @memberof RemoteCallbacks - */ credentials?: Function; - /** - * - * - * @type {Function} - * @memberof RemoteCallbacks - */ certificateCheck?: Function; - /** - * - * - * @type {Function} - * @memberof RemoteCallbacks - */ transferProgress?: Function; - /** - * - * - * @type {Function} - * @memberof RemoteCallbacks - */ transport?: Function; - /** - * - * - * @type {undefined} - * @memberof RemoteCallbacks - */ payload?: undefined; } diff --git a/types/nodegit/remote.d.ts b/types/nodegit/remote.d.ts index d1bee99365..5f118629ea 100644 --- a/types/nodegit/remote.d.ts +++ b/types/nodegit/remote.d.ts @@ -24,367 +24,48 @@ export namespace Remote { } export class Remote { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} remote - * @param {string} refspec - * @returns {number} - * - * @memberof Remote - */ static addFetch(repo: Repository, remote: string, refspec: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} remote - * @param {string} refspec - * @returns {number} - * - * @memberof Remote - */ static addPush(repo: Repository, remote: string, refspec: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} url - * @returns {Remote} - * - * @memberof Remote - */ static create(repo: Repository, name: string, url: string): Remote; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} url - * @returns {Promise} - * - * @memberof Remote - */ static createAnonymous(repo: Repository, url: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} url - * @param {string} fetch - * @returns {Promise} - * - * @memberof Remote - */ static createWithFetchspec(repo: Repository, name: string, url: string, fetch: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @returns {Promise} - * - * @memberof Remote - */ static delete(repo: Repository, name: string): Promise; - /** - * - * - * @static - * @param {RemoteCallbacks} opts - * @param {number} version - * @returns {number} - * - * @memberof Remote - */ static initCallbacks(opts: RemoteCallbacks, version: number): number; - /** - * - * - * @static - * @param {string} remoteName - * @returns {number} - * - * @memberof Remote - */ static isValidName(remoteName: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @returns {Promise} - * - * @memberof Remote - */ static list(repo: Repository): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {(string | Remote)} name - * @param {Function} callback - * @returns {Promise} - * - * @memberof Remote - */ static lookup(repo: Repository, name: string | Remote, callback: Function): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} remote - * @param {number} value - * @returns {number} - * - * @memberof Remote - */ static setAutotag(repo: Repository, remote: string, value: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} remote - * @param {string} url - * @returns {number} - * - * @memberof Remote - */ static setPushurl(repo: Repository, remote: string, url: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} remote - * @param {string} url - * @returns {number} - * - * @memberof Remote - */ static setUrl(repo: Repository, remote: string, url: string): number; - /** - * - * - * @returns {number} - * - * @memberof Remote - */ autotag(): number; - /** - * - * - * @param {Enums.DIRECTION} direction - * @param {RemoteCallbacks} callbacks - * @param {Function} callback - * @returns {Promise} - * - * @memberof Remote - */ connect(direction: Enums.DIRECTION, callbacks: RemoteCallbacks, callback: Function): Promise; - /** - * - * - * @returns {number} - * - * @memberof Remote - */ connected(): number; - /** - * - * - * @returns {Promise} - * - * @memberof Remote - */ defaultBranch(): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Remote - */ disconnect(): Promise; - /** - * - * - * @param {any[]} refSpecs - * @param {FetchOptions} opts - * @param {Function} callback - * @returns {Promise} - * - * @memberof Remote - */ download(refSpecs: any[], opts: FetchOptions, callback: Function): Promise; dup(): Promise; - /** - * - * - * @param {any[]} refSpecs - * @param {FetchOptions} opts - * @param {string} message - * @param {Function} callback - * @returns {Promise} - * - * @memberof Remote - */ fetch(refSpecs: any[], opts: FetchOptions, message: string, callback: Function): Promise; - /** - * - * - * - * @memberof Remote - */ + free(): void; - /** - * - * - * @returns {Promise} - * - * @memberof Remote - */ getFetchRefspecs(): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Remote - */ getPushRefspecs(): Promise; - /** - * - * - * @param {number} n - * @returns {Refspec} - * - * @memberof Remote - */ getRefspec(n: number): Refspec; - /** - * - * - * @returns {string} - * - * @memberof Remote - */ name(): string; - /** - * - * - * @returns {Repository} - * - * @memberof Remote - */ owner(): Repository; - /** - * - * - * @param {RemoteCallbacks} callbacks - * @returns {number} - * - * @memberof Remote - */ prune(callbacks: RemoteCallbacks): number; - /** - * - * - * @returns {number} - * - * @memberof Remote - */ pruneRefs(): number; - /** - * - * - * @param {any[]} refSpecs - * @param {PushOptions} options - * @param {Function} callback - * @returns {Promise} - * - * @memberof Remote - */ push(refSpecs: any[], options: PushOptions, callback: Function): Promise; - /** - * - * - * @returns {string} - * - * @memberof Remote - */ pushurl(): string; - /** - * - * - * @returns {number} - * - * @memberof Remote - */ refspecCount(): number; - /** - * - * - * @returns {TransferProgress} - * - * @memberof Remote - */ stats(): TransferProgress; - /** - * - * - * - * @memberof Remote - */ + stop(): void; - /** - * - * - * @param {RemoteCallbacks} callbacks - * @param {number} updateFetchhead - * @param {number} downloadTags - * @param {string} reflogMessage - * @returns {number} - * - * @memberof Remote - */ updateTips(callbacks: RemoteCallbacks, updateFetchhead: number, downloadTags: number, reflogMessage: string): number; - /** - * - * - * @param {Strarray} refspecs - * @param {PushOptions} opts - * @returns {number} - * - * @memberof Remote - */ upload(refspecs: Strarray, opts: PushOptions): number; - /** - * - * - * @returns {string} - * - * @memberof Remote - */ url(): string; /** * Lists advertised references from a remote. You must connect to the remote before using referenceList. - * - * @returns {Promise} - * - * @memberof Remote */ referenceList(): Promise; } diff --git a/types/nodegit/repository.d.ts b/types/nodegit/repository.d.ts index b29a411725..fa3d235b37 100644 --- a/types/nodegit/repository.d.ts +++ b/types/nodegit/repository.d.ts @@ -33,754 +33,212 @@ export interface RepositoryInitOptions { export class Repository { /** * Creates a branch with the passed in name pointing to the commit - * - * @static - * @param {string} startPath - * @param {number} acrossFs - * @param {string} ceilingDirs - * @returns {Promise} - * - * @memberof Repository */ static discover(startPath: string, acrossFs: number, ceilingDirs: string): Promise; - /** - * - * - * @static - * @param {string} path - * @param {number} isBare - * @returns {Promise} - * - * @memberof Repository - */ static init(path: string, isBare: number): Promise; - /** - * - * - * @static - * @param {string} repoPath - * @param {RepositoryInitOptions} [options] - * @returns {Promise} - * - * @memberof Repository - */ static initExt(repoPath: string, options?: RepositoryInitOptions): Promise; - /** - * - * - * @static - * @param {string} path - * @returns {Promise} - * - * @memberof Repository - */ static open(path: string): Promise; - /** - * - * - * @static - * @param {string} barePath - * @returns {Promise} - * - * @memberof Repository - */ static openBare(barePath: string): Promise; - /** - * - * - * @static - * @param {string} path - * @param {number} [flags] - * @param {string} [ceilingDirs] - * @returns {Promise} - * - * @memberof Repository - */ static openExt(path: string, flags?: number, ceilingDirs?: string): Promise; - /** - * - * - * @static - * @param {Odb} odb - * @returns {Promise} - * - * @memberof Repository - */ static wrapOdb(odb: Odb): Promise; - /** - * - * - * - * @memberof Repository - */ cleanup(): void; - /** - * - * - * @returns {Promise} - * - * @memberof Repository - */ config(): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Repository - */ configSnapshot(): Promise; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ detachHead(): number; - /** - * - * - * @param {Function} callback - * @returns {Promise} - * - * @memberof Repository - */ fetchheadForeach(callback: Function): Promise; - /** - * - * - * - * @memberof Repository - */ + free(): void; - /** - * - * - * @returns {string} - * - * @memberof Repository - */ getNamespace(): string; - /** - * - * - * @returns {Promise} - * - * @memberof Repository - */ head(): Promise; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ headDetached(): number; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ headUnborn(): number; - /** - * - * - * @returns {Promise} - * - * @memberof Repository - */ index(): Promise; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ isBare(): number; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ isEmpty(): number; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ isShallow(): number; - /** - * - * - * @param {Function} callback - * @returns {Promise} - * - * @memberof Repository - */ mergeheadForeach(callback: Function): Promise; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ messageRemove(): number; - /** - * - * - * @returns {Promise} - * - * @memberof Repository - */ odb(): Promise; - /** - * - * - * @returns {string} - * - * @memberof Repository - */ path(): string; - /** - * - * - * @returns {Promise} - * - * @memberof Repository - */ refdb(): Promise; - /** - * - * - * @param {string} refname - * @returns {Promise} - * - * @memberof Repository - */ setHead(refname: string): Promise; - /** - * - * - * @param {Oid} commitish - * @returns {number} - * - * @memberof Repository - */ setHeadDetached(commitish: Oid): number; - /** - * - * - * @param {AnnotatedCommit} commitish - * @returns {number} - * - * @memberof Repository - */ setHeadDetachedFromAnnotated(commitish: AnnotatedCommit): number; - /** - * - * - * @param {string} name - * @param {string} email - * @returns {number} - * - * @memberof Repository - */ setIdent(name: string, email: string): number; - /** - * - * - * @param {string} nmspace - * @returns {number} - * - * @memberof Repository - */ setNamespace(nmspace: string): number; - /** - * - * - * @param {string} workdir - * @param {number} updateGitLink - * @returns {number} - * - * @memberof Repository - */ setWorkdir(workdir: string, updateGitLink: number): number; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ state(): number; - /** - * - * - * @returns {number} - * - * @memberof Repository - */ stateCleanup(): number; - /** - * - * - * @returns {string} - * - * @memberof Repository - */ workdir(): string; /** * Creates a branch with the passed in name pointing to the commit - * - * @param {string} name - * @param {(Commit | string | Oid)} commit - * @param {boolean} force - * @param {Signature} signature - * @param {string} logMessage - * @returns {Promise} - * - * @memberof Repository */ createBranch(name: string, commit: Commit | string | Oid, force: boolean, signature: Signature, logMessage: string): Promise; /** * Look up a refs's commit. - * - * @param {(string | Reference)} name - * @returns {Promise} - * - * @memberof Repository */ getReferenceCommit(name: string | Reference): Promise; /** * Look up a branch. Alias for getReference - * - * @param {(string | Reference)} name - * @returns {Promise} - * - * @memberof Repository */ getBranch(name: string | Reference): Promise; /** * Look up a branch's most recent commit. Alias to getReferenceCommit - * - * @param {(string | Reference)} name - * @returns {Promise} - * - * @memberof Repository */ getBranchCommit(name: string | Reference): Promise; /** * Gets the branch that HEAD currently points to Is an alias to head() - * - * @returns {Promise} - * - * @memberof Repository */ getCurrentBranch(): Promise; /** * Lookup the reference with the given name. - * - * @param {(string | Reference)} name - * @returns {Promise} - * - * @memberof Repository */ getReference(name: string | Reference): Promise; /** * Lookup references for a repository. - * - * @param {Reference.TYPE} type - * @returns {Promise} - * - * @memberof Repository */ getReferences(type: Reference.TYPE): Promise; /** * Lookup reference names for a repository. - * - * @param {Reference.TYPE} type - * @returns {Promise} - * - * @memberof Repository */ getReferenceNames(type: Reference.TYPE): Promise; - /** - * - * - * @param {(string | Oid)} string - * @returns {Promise} - * - * @memberof Repository - */ getCommit(string: string | Oid): Promise; /** * Retrieve the blob represented by the oid. - * - * @param {(string | Oid)} string - * @returns {Promise} - * - * @memberof Repository */ getBlob(string: string | Oid): Promise; /** * Retrieve the tree represented by the oid. - * - * @param {(string | Oid)} string - * @returns {Promise} - * - * @memberof Repository */ getTree(string: string | Oid): Promise; - /** - * - * - * @param {(string | Oid)} string - * @param {string} name - * @param {string} message - * @returns {Promise} - * - * @memberof Repository - */ createTag(string: string | Oid, name: string, message: string): Promise; /** * Creates a new lightweight tag - * - * @param {(string | Oid)} string - * @param {string} name - * @returns {Promise} - * - * @memberof Repository */ createLightweightTag(string: string | Oid, name: string): Promise; /** * Retrieve the tag represented by the oid. - * - * @param {(string | Oid)} string - * @returns {Promise} - * - * @memberof Repository */ getTag(string: string | Oid): Promise; /** * Retrieve the tag represented by the tag name. - * - * @param {string} Short - * @returns {Promise} - * - * @memberof Repository */ getTagByName(Short: string): Promise; /** * Deletes a tag from a repository by the tag name. - * - * @param {string} Short - * @returns {Promise} - * - * @memberof Repository */ deleteTagByName(Short: string): Promise; /** * Instantiate a new revision walker for browsing the Repository"s history. See also Commit.prototype.history() - * - * @param {(string | Oid)} string - * @returns {Revwalk} - * - * @memberof Repository */ createRevWalk(string: string | Oid): Revwalk; /** * Retrieve the master branch commit. - * - * @returns {Promise} - * - * @memberof Repository */ getMasterCommit(): Promise; /** * Retrieve the commit that HEAD is currently pointing to - * - * @returns {Promise} - * - * @memberof Repository */ getHeadCommit(): Promise; - /** - * - * - * @param {string} updateRef - * @param {Signature} author - * @param {Signature} committer - * @param {string} message - * @param {(Tree | Oid | string)} Tree - * @param {any[]} parents - * @returns {Promise} - * - * @memberof Repository - */ createCommit(updateRef: string, author: Signature, committer: Signature, message: string, Tree: Tree | Oid | string, parents: any[]): Promise; /** * Creates a new commit on HEAD from the list of passed in files - * - * @param {any[]} filesToAdd - * @param {Signature} author - * @param {Signature} committer - * @param {string} message - * @returns {Promise} - * - * @memberof Repository */ createCommitOnHead(filesToAdd: any[], author: Signature, committer: Signature, message: string): Promise; /** * Create a blob from a buffer - * - * @param {Buffer} buffer - * @returns {Oid} - * - * @memberof Repository */ createBlobFromBuffer(buffer: Buffer): Oid; - /** - * - * - * @param {Tree} tree - * @returns {*} - * - * @memberof Repository - */ treeBuilder(tree: Tree): any; /** * Gets the default signature for the default user and now timestamp - * - * @returns {Signature} - * - * @memberof Repository */ defaultSignature(): Signature; /** * Lists out the remotes in the given repository. - * - * @param {Function} Optional - * @returns {Promise} - * - * @memberof Repository */ getRemotes(Optional: Function): Promise; /** * Gets a remote from the repo - * - * @param {(string | Remote)} remote - * @param {Function} callback - * @returns {Promise} - * - * @memberof Repository */ getRemote(remote: string | Remote, callback: Function): Promise; /** * Fetches from a remote - * - * @param {(string | Remote)} remote - * @param {(Object | FetchOptions)} fetchOptions - * @returns {Promise} - * - * @memberof Repository */ fetch(remote: string | Remote, fetchOptions: Object | FetchOptions): Promise; /** * Fetches from all remotes. This is done in series due to deadlocking issues with fetching from many remotes that can happen. - * - * @param {(Object | FetchOptions)} fetchOptions - * @param {Function} callback - * @returns {Promise} - * - * @memberof Repository */ fetchAll(fetchOptions: Object | FetchOptions, callback: Function): Promise; - /** - * - * - * @param {(string | Reference)} to - * @param {(string | Reference)} from - * @param {Signature} signature - * @param {Merge.PREFERENCE} mergePreference - * @param {MergeOptions} mergeOptions - * @returns {Promise} - * - * @memberof Repository - */ mergeBranches(to: string | Reference, from: string | Reference, signature: Signature, mergePreference: Merge.PREFERENCE, mergeOptions: MergeOptions): Promise; /** * Rebases a branch onto another branch - * - * @param {string} branch - * @param {string} upstream - * @param {string} onto - * @param {Signature} signature - * @param {Function} beforeNextFn - * @returns {Promise} - * - * @memberof Repository */ rebaseBranches(branch: string, upstream: string, onto: string, signature: Signature, beforeNextFn: Function): Promise; - /** - * - * - * @param {Signature} signature - * @param {Function} beforeNextFn - * @returns {Promise} - * - * @memberof Repository - */ continueRebase(signature: Signature, beforeNextFn: Function): Promise; /** * Get the status of a repo to it's working directory - * - * @param {*} opts - * @returns {Promise} - * - * @memberof Repository */ getStatus(opts: any): Promise; /** * Get extended statuses of a repo to it's working directory. Status entries have status, headToIndex delta, and indexToWorkdir deltas - * - * @param {*} opts - * @returns {Promise} - * - * @memberof Repository */ getStatusExt(opts: any): Promise; /** * Get the names of the submodules in the repository. - * - * @returns {Promise} - * - * @memberof Repository */ getSubmoduleNames(): Promise; /** * This will set the HEAD to point to the reference and then attempt to update the index and working tree to match the content of the latest commit on that reference - * - * @param {Reference} reference - * @param {(Object | CheckoutOptions)} opts - * @returns {Promise} - * - * @memberof Repository */ checkoutRef(reference: Reference, opts: Object | CheckoutOptions): Promise; /** * This will set the HEAD to point to the local branch and then attempt to update the index and working tree to match the content of the latest commit on that branch - * - * @param {(string | Reference)} branch - * @param {(Object | CheckoutOptions)} opts - * @returns {Promise} - * - * @memberof Repository */ checkoutBranch(branch: string | Reference, opts: Object | CheckoutOptions): Promise; /** * Stages or unstages line selection of a specified file - * - * @param {(string | any[])} filePath - * @param {boolean} stageNew - * @returns {Promise} - * - * @memberof Repository */ stageFilemode(filePath: string | any[], stageNew: boolean): Promise; /** * Stages or unstages line selection of a specified file - * - * @param {string} filePath - * @param {any[]} newLines - * @param {boolean} isStaged - * @returns {Promise} - * - * @memberof Repository */ stageLines(filePath: string, newLines: any[], isStaged: boolean): Promise; /** * Returns true if the repository is in the default NONE state. - * - * @returns {boolean} - * - * @memberof Repository */ isDefaultState(): boolean; /** * Returns true if the repository is in the APPLY_MAILBOX or APPLY_MAILBOX_OR_REBASE state. - * - * @returns {boolean} - * - * @memberof Repository */ isApplyingMailbox(): boolean; /** * Returns true if the repository is in the BISECT state. - * - * @returns {boolean} - * - * @memberof Repository */ isBisecting(): boolean; /** * Returns true if the repository is in the CHERRYPICK state. - * - * @returns {boolean} - * - * @memberof Repository */ isCherrypicking(): boolean; /** * Returns true if the repository is in the MERGE state. - * - * @returns {boolean} - * - * @memberof Repository */ isMerging(): boolean; /** * Returns true if the repository is in the REBASE, REBASE_INTERACTIVE, or REBASE_MERGE state. - * - * @returns {boolean} - * - * @memberof Repository */ isRebasing(): boolean; /** * Returns true if the repository is in the REVERT state. - * - * @returns {boolean} - * - * @memberof Repository */ isReverting(): boolean; /** * Discard line selection of a specified file. Assumes selected lines are unstaged. - * - * @param {string} filePath - * @param {any[]} selectedLines - * @returns {Promise} - * - * @memberof Repository */ discardLines(filePath: string, selectedLines: any[]): Promise; /** * Grabs a fresh copy of the index from the repository. Invalidates all previously grabbed indexes - * - * @returns {Promise} - * - * @memberof Repository */ refreshIndex(): Promise; } diff --git a/types/nodegit/reset.d.ts b/types/nodegit/reset.d.ts index 0fb3af1088..800ad34434 100644 --- a/types/nodegit/reset.d.ts +++ b/types/nodegit/reset.d.ts @@ -15,42 +15,16 @@ export namespace Reset { export class Reset { /** * Look up a refs's commit. - * - * @static - * @param {Repository} repo - * @param {Object} target - * @param {number} resetType - * @param {CheckoutOptions} checkoutOpts - * @returns {Promise} - * - * @memberof Reset */ static reset(repo: Repository, target: Object, resetType: number, checkoutOpts: CheckoutOptions): Promise; /** * Look up a refs's commit. - * - * @static - * @param {Repository} repo - * @param {Object} target - * @param {Strarray} pathspecs - * @returns {Promise} - * - * @memberof Reset */ static default(repo: Repository, target: Object, pathspecs: Strarray): Promise; /** * Sets the current head to the specified commit oid and optionally resets the index and working tree to match. * This behaves like reset but takes an annotated commit, which lets you specify which extended sha syntax string was specified by a user, allowing for more exact reflog messages. * See the documentation for reset. - * - * @static - * @param {Repository} repo - * @param {AnnotatedCommit} commit - * @param {number} resetType - * @param {CheckoutOptions} checkoutOpts - * @returns {number} - * - * @memberof Reset */ static fromAnnotated(repo: Repository, commit: AnnotatedCommit, resetType: number, checkoutOpts: CheckoutOptions): number; } diff --git a/types/nodegit/rev-parse.d.ts b/types/nodegit/rev-parse.d.ts index 098f880cd0..c878b791fd 100644 --- a/types/nodegit/rev-parse.d.ts +++ b/types/nodegit/rev-parse.d.ts @@ -11,28 +11,6 @@ export namespace Revparse { } export class Revparse { - /** - * - * - * @static - * @param {Object} objectOut - * @param {Reference} referenceOut - * @param {Repository} repo - * @param {string} spec - * @returns {number} - * - * @memberof Revparse - */ static ext(objectOut: Object, referenceOut: Reference, repo: Repository, spec: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} spec - * @returns {Promise} - * - * @memberof Revparse - */ static single(repo: Repository, spec: string): Promise; } diff --git a/types/nodegit/rev-walk.d.ts b/types/nodegit/rev-walk.d.ts index 2736f57323..59611cf62b 100644 --- a/types/nodegit/rev-walk.d.ts +++ b/types/nodegit/rev-walk.d.ts @@ -12,179 +12,36 @@ export namespace Revwalk { } export class Revwalk { - /** - * - * - * @static - * @param {Repository} repo - * @returns {Revwalk} - * - * @memberof Revwalk - */ static create(repo: Repository): Revwalk; - /** - * - * - * @param {Oid} commitId - * @returns {number} - * - * @memberof Revwalk - */ hide(commitId: Oid): number; - /** - * - * - * @param {string} glob - * @returns {number} - * - * @memberof Revwalk - */ hideGlob(glob: string): number; - /** - * - * - * @returns {number} - * - * @memberof Revwalk - */ hideHead(): number; - /** - * - * - * @param {string} refname - * @returns {number} - * - * @memberof Revwalk - */ hideRef(refname: string): number; - /** - * - * - * @returns {Promise} - * - * @memberof Revwalk - */ next(): Promise; - /** - * - * - * @param {Oid} id - * @returns {number} - * - * @memberof Revwalk - */ push(id: Oid): number; - /** - * - * - * @param {string} glob - * @returns {number} - * - * @memberof Revwalk - */ pushGlob(glob: string): number; - /** - * - * - * @returns {number} - * - * @memberof Revwalk - */ pushHead(): number; - /** - * - * - * @param {string} range - * @returns {number} - * - * @memberof Revwalk - */ pushRange(range: string): number; - /** - * - * - * @param {string} refname - * @returns {number} - * - * @memberof Revwalk - */ pushRef(refname: string): number; - /** - * - * - * @returns {Repository} - * - * @memberof Revwalk - */ repository(): Repository; - /** - * - * - * - * @memberof Revwalk - */ + reset(): void; - /** - * - * - * - * @memberof Revwalk - */ + simplifyFirstParent(): void; /** * Set the sort order for the revwalk. This function takes variable arguments like revwalk.sorting(NodeGit.RevWalk.Topological, NodeGit.RevWalk.Reverse). - * - * @param {number} sort - * - * @memberof Revwalk */ sorting(sort: number): void; - /** - * - * - * @param {number} maxCount - * @returns {Promise} - * - * @memberof Revwalk - */ fastWalk(maxCount: number): Promise; - /** - * - * - * @param {string} filePath - * @param {number} maxCount - * @returns {Promise} - * - * @memberof Revwalk - */ fileHistoryWalk(filePath: string, maxCount: number): Promise; /** * Walk the history from the given oid. The callback is invoked for each commit; When the walk is over, the callback is invoked with (null, null). - * - * @param {Oid} oid - * @param {Function} callback - * @returns {Commit} - * - * @memberof Revwalk */ walk(oid: Oid, callback: Function): Commit; /** * Walk the history grabbing commits until the checkFn called with the current commit returns false. - * - * @param {Function} checkFn - * @returns {Promise} - * - * @memberof Revwalk */ getCommitsUntil(checkFn: Function): Promise; - /** - * - * - * @param {number} count - * @returns {Promise} - * - * @memberof Revwalk - */ getCommits(count: number): Promise; } diff --git a/types/nodegit/revert.d.ts b/types/nodegit/revert.d.ts index 2e04f78758..16154aea76 100644 --- a/types/nodegit/revert.d.ts +++ b/types/nodegit/revert.d.ts @@ -12,30 +12,9 @@ export interface RevertOptions { } export class Revert { - /** - * - * - * @static - * @param {Repository} repo - * @param {Commit} commit - * @param {RevertOptions} givenOpts - * @returns {Promise} - * - * @memberof Revert - */ static revert(repo: Repository, commit: Commit, givenOpts: RevertOptions): Promise; /** * Reverts the given commit against the given "our" commit, producing an index that reflects the result of the revert. - * - * @static - * @param {Repository} repo - * @param {Commit} revertCommit - * @param {Commit} ourCommit - * @param {number} mainline - * @param {MergeOptions} mergeOptions - * @returns {Promise} - * - * @memberof Revert */ static commit(repo: Repository, revertCommit: Commit, ourCommit: Commit, mainline: number, mergeOptions: MergeOptions): Promise; } diff --git a/types/nodegit/signature.d.ts b/types/nodegit/signature.d.ts index 6854760004..3e62110d0c 100644 --- a/types/nodegit/signature.d.ts +++ b/types/nodegit/signature.d.ts @@ -2,93 +2,16 @@ import { Repository } from './repository'; import { Time } from './time'; export class Signature { - /** - * - * - * @static - * @param {Repository} repo - * @returns {Signature} - * - * @memberof Signature - */ static default(repo: Repository): Signature; - /** - * - * - * @static - * @param {string} name - * @param {string} email - * @param {number} time - * @param {number} offset - * @returns {Signature} - * - * @memberof Signature - */ static create(name: string, email: string, time: number, offset: number): Signature; - /** - * - * - * @static - * @param {string} name - * @param {string} email - * @returns {Signature} - * - * @memberof Signature - */ static now(name: string, email: string): Signature; - /** - * - * - * @static - * @param {string} buf - * @returns {Promise} - * - * @memberof Signature - */ static fromBuffer(buf: string): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Signature - */ dup(): Promise; - /** - * - * - * - * @memberof Signature - */ + free(): void; - /** - * - * - * @returns {string} - * - * @memberof Signature - */ toString(): string; - /** - * - * - * @type {string} - * @memberof Signature - */ name: string; - /** - * - * - * @type {string} - * @memberof Signature - */ email: string; - /** - * - * - * @type {Time} - * @memberof Signature - */ when: Time; } diff --git a/types/nodegit/stash.d.ts b/types/nodegit/stash.d.ts index 1aae88bd85..494631928c 100644 --- a/types/nodegit/stash.d.ts +++ b/types/nodegit/stash.d.ts @@ -29,113 +29,18 @@ export namespace Stash { } export interface StashApplyOptions { - /** - * - * - * @type {number} - * @memberof StashApplyOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof StashApplyOptions - */ flags?: number; - /** - * - * - * @type {CheckoutOptions} - * @memberof StashApplyOptions - */ checkoutOptions?: CheckoutOptions; - /** - * - * - * @type {Function} - * @memberof StashApplyOptions - */ progressCb?: Function; - /** - * - * - * @type {*} - * @memberof StashApplyOptions - */ progressPayload?: any; } export class Stash { - /** - * - * - * @static - * @param {Repository} repo - * @param {number} index - * @param {StashApplyOptions} options - * @returns {Promise} - * - * @memberof Stash - */ static apply(repo: Repository, index: number, options: StashApplyOptions): Promise; - /** - * - * - * @static - * @param {StashApplyOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Stash - */ static applyInitOptions(opts: StashApplyOptions, version: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {number} index - * @returns {Promise} - * - * @memberof Stash - */ static drop(repo: Repository, index: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Function} callback - * @param {*} payload - * @returns {Promise} - * - * @memberof Stash - */ static foreach(repo: Repository, callback: Function, payload: any): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {number} index - * @param {StashApplyOptions} options - * @returns {Promise} - * - * @memberof Stash - */ static pop(repo: Repository, index: number, options: StashApplyOptions): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Signature} stasher - * @param {string} message - * @param {number} flags - * @returns {Promise} - * - * @memberof Stash - */ static save(repo: Repository, stasher: Signature, message: string, flags: number): Promise; } diff --git a/types/nodegit/status-entry.d.ts b/types/nodegit/status-entry.d.ts index 70435d5de1..bc2ab62a12 100644 --- a/types/nodegit/status-entry.d.ts +++ b/types/nodegit/status-entry.d.ts @@ -1,25 +1,7 @@ import { DiffDelta } from './diff-delta'; export class StatusEntry { - /** - * - * - * @type {number} - * @memberof StatusEntry - */ status: number; - /** - * - * - * @type {DiffDelta} - * @memberof StatusEntry - */ headToIndex: DiffDelta; - /** - * - * - * @type {DiffDelta} - * @memberof StatusEntry - */ indexToWorkdir: DiffDelta; } diff --git a/types/nodegit/status-list.d.ts b/types/nodegit/status-list.d.ts index 7847da4d1d..42119bbfd4 100644 --- a/types/nodegit/status-list.d.ts +++ b/types/nodegit/status-list.d.ts @@ -3,39 +3,10 @@ import { DiffPerfdata } from './diff-perf-data'; import { StatusOptions } from './status-options'; export class StatusList { - /** - * - * - * @static - * @param {Repository} repo - * @param {StatusOptions} opts - * @returns {Promise} - * - * @memberof StatusList - */ static create(repo: Repository, opts: StatusOptions): Promise; - /** - * - * - * @returns {number} - * - * @memberof StatusList - */ entrycount(): number; - /** - * - * - * - * @memberof StatusList - */ + free(): void; - /** - * - * - * @returns {Promise} - * - * @memberof StatusList - */ getPerfdata(): Promise; } diff --git a/types/nodegit/status-options.d.ts b/types/nodegit/status-options.d.ts index fe2f728737..9f75bbe96d 100644 --- a/types/nodegit/status-options.d.ts +++ b/types/nodegit/status-options.d.ts @@ -1,32 +1,8 @@ import { Strarray } from './str-array'; export interface StatusOptions { - /** - * - * - * @type {number} - * @memberof StatusOptions - */ version?: number; - /** - * - * - * @type {number} - * @memberof StatusOptions - */ show?: number; - /** - * - * - * @type {number} - * @memberof StatusOptions - */ flags?: number; - /** - * - * - * @type {Strarray} - * @memberof StatusOptions - */ pathspec?: Strarray; } diff --git a/types/nodegit/status.d.ts b/types/nodegit/status.d.ts index 892b1f1c36..1059dd6bff 100644 --- a/types/nodegit/status.d.ts +++ b/types/nodegit/status.d.ts @@ -48,63 +48,9 @@ export namespace Status { } export class Status { - /** - * - * - * @static - * @param {StatusList} statuslist - * @param {number} idx - * @returns {StatusEntry} - * - * @memberof Status - */ static byIndex(statuslist: StatusList, idx: number): StatusEntry; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} path - * @returns {number} - * - * @memberof Status - */ static file(repo: Repository, path: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {Function} callback - * @param {*} payload - * @returns {Promise} - * - * @memberof Status - */ static foreach(repo: Repository, callback: Function, payload: any): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {StatusOptions} opts - * @param {Function} callback - * @param {*} payload - * @returns {Promise} - * - * @memberof Status - */ static foreachExt(repo: Repository, opts: StatusOptions, callback: Function, payload: any): Promise; - /** - * - * - * @static - * @param {number} ignored - * @param {Repository} repo - * @param {string} path - * @returns {number} - * - * @memberof Status - */ static shouldIgnore(ignored: number, repo: Repository, path: string): number; } diff --git a/types/nodegit/str-array.d.ts b/types/nodegit/str-array.d.ts index 603889f756..44f5914be7 100644 --- a/types/nodegit/str-array.d.ts +++ b/types/nodegit/str-array.d.ts @@ -1,32 +1,7 @@ export class Strarray { - /** - * - * - * @param {Strarray} src - * @returns {number} - * - * @memberof Strarray - */ copy(src: Strarray): number; - /** - * - * - * - * @memberof Strarray - */ + free(): void; - /** - * - * - * @type {string[]} - * @memberof Strarray - */ strings: string[]; - /** - * - * - * @type {number} - * @memberof Strarray - */ count: number; } diff --git a/types/nodegit/submodule-update-options.d.ts b/types/nodegit/submodule-update-options.d.ts index 3b07383090..d96320204b 100644 --- a/types/nodegit/submodule-update-options.d.ts +++ b/types/nodegit/submodule-update-options.d.ts @@ -2,32 +2,8 @@ import { CheckoutOptions } from './checkout-options'; import { FetchOptions } from './fetch-options'; export interface SubmoduleUpdateOptions { - /** - * - * - * @type {number} - * @memberof SubmoduleUpdateOptions - */ version?: number; - /** - * - * - * @type {CheckoutOptions} - * @memberof SubmoduleUpdateOptions - */ checkoutOpts?: CheckoutOptions; - /** - * - * - * @type {FetchOptions} - * @memberof SubmoduleUpdateOptions - */ fetchOpts?: FetchOptions; - /** - * - * - * @type {number} - * @memberof SubmoduleUpdateOptions - */ cloneCheckoutStrategy?: number; } diff --git a/types/nodegit/submodule.d.ts b/types/nodegit/submodule.d.ts index a946e28fa4..c53aee7a3d 100644 --- a/types/nodegit/submodule.d.ts +++ b/types/nodegit/submodule.d.ts @@ -45,308 +45,43 @@ export namespace Submodule { } export class Submodule { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} url - * @param {string} path - * @param {number} useGitLink - * @returns {Promise} - * - * @memberof Submodule - */ static addSetup(repo: Repository, url: string, path: string, useGitLink: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Function} callback - * @param {*} payload - * @returns {Promise} - * - * @memberof Submodule - */ static foreach(repo: Repository, callback: Function, payload: any): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @returns {Promise} - * - * @memberof Submodule - */ static lookup(repo: Repository, name: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} url - * @returns {Promise} - * - * @memberof Submodule - */ static resolveUrl(repo: Repository, url: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} branch - * @returns {number} - * - * @memberof Submodule - */ static setBranch(repo: Repository, name: string, branch: string): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {number} fetchRecurseSubmodules - * @returns {number} - * - * @memberof Submodule - */ static setFetchRecurseSubmodules(repo: Repository, name: string, fetchRecurseSubmodules: number): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {number} ignore - * @returns {Promise} - * - * @memberof Submodule - */ static setIgnore(repo: Repository, name: string, ignore: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {number} update - * @returns {Promise} - * - * @memberof Submodule - */ static setUpdate(repo: Repository, name: string, update: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {string} url - * @returns {Promise} - * - * @memberof Submodule - */ static setUrl(repo: Repository, name: string, url: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} name - * @param {number} ignore - * @returns {Promise} - * - * @memberof Submodule - */ static status(repo: Repository, name: string, ignore: number): Promise; - /** - * - * - * @static - * @param {SubmoduleUpdateOptions} opts - * @param {number} version - * @returns {number} - * - * @memberof Submodule - */ static updateInitOptions(opts: SubmoduleUpdateOptions, version: number): number; - /** - * - * - * @returns {Promise} - * - * @memberof Submodule - */ addFinalize(): Promise; - /** - * - * - * @param {number} writeIndex - * @returns {Promise} - * - * @memberof Submodule - */ addToIndex(writeIndex: number): Promise; - /** - * - * - * @returns {string} - * - * @memberof Submodule - */ branch(): string; - /** - * - * - * @returns {number} - * - * @memberof Submodule - */ fetchRecurseSubmodules(): number; - /** - * - * - * - * @memberof Submodule - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Submodule - */ headId(): Oid; - /** - * - * - * @returns {number} - * - * @memberof Submodule - */ ignore(): number; - /** - * - * - * @returns {Oid} - * - * @memberof Submodule - */ indexId(): Oid; - /** - * - * - * @param {number} overwrite - * @returns {Promise} - * - * @memberof Submodule - */ init(overwrite: number): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Submodule - */ location(): Promise; - /** - * - * - * @returns {string} - * - * @memberof Submodule - */ name(): string; - /** - * - * - * @returns {Promise} - * - * @memberof Submodule - */ open(): Promise; - /** - * - * - * @returns {Repository} - * - * @memberof Submodule - */ owner(): Repository; - /** - * - * - * @returns {string} - * - * @memberof Submodule - */ path(): string; - /** - * - * - * @param {number} force - * @returns {number} - * - * @memberof Submodule - */ reload(force: number): number; - /** - * - * - * @param {number} useGitLink - * @returns {Promise} - * - * @memberof Submodule - */ repoInit(useGitLink: number): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Submodule - */ sync(): Promise; /** * Updates a submodule * - * @param {number} init - * @param {SubmoduleUpdateOptions} options - * @returns {Promise} * - * @memberof Submodule */ update(init: number, options: SubmoduleUpdateOptions): Promise; - /** - * - * - * @returns {number} - * - * @memberof Submodule - */ updateStrategy(): number; - /** - * - * - * @returns {string} - * - * @memberof Submodule - */ url(): string; - /** - * - * - * @returns {Oid} - * - * @memberof Submodule - */ wdId(): Oid; } diff --git a/types/nodegit/tag.d.ts b/types/nodegit/tag.d.ts index f676c72ab5..3f6b5aa836 100644 --- a/types/nodegit/tag.d.ts +++ b/types/nodegit/tag.d.ts @@ -5,191 +5,30 @@ import { Signature } from './signature'; import { Strarray } from './str-array'; export class Tag { - /** - * - * - * @static - * @param {Repository} repo - * @param {string} tagName - * @param {Object} target - * @param {Signature} tagger - * @param {string} message - * @returns {Promise} - * - * @memberof Tag - */ static annotationCreate(repo: Repository, tagName: string, target: Object, tagger: Signature, message: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} tagName - * @param {Object} target - * @param {Signature} tagger - * @param {string} message - * @param {number} force - * @returns {Promise} - * - * @memberof Tag - */ static create(repo: Repository, tagName: string, target: Object, tagger: Signature, message: string, force: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} tagName - * @param {Object} target - * @param {number} force - * @returns {Promise} - * - * @memberof Tag - */ static createLightweight(repo: Repository, tagName: string, target: Object, force: number): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {string} tagName - * @returns {Promise} - * - * @memberof Tag - */ static delete(repo: Repository, tagName: string): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @returns {Promise} - * - * @memberof Tag - */ static list(repo: Repository): Promise; - /** - * - * - * @static - * @param {Strarray} tagNames - * @param {string} pattern - * @param {Repository} repo - * @returns {number} - * - * @memberof Tag - */ static listMatch(tagNames: Strarray, pattern: string, repo: Repository): number; /** * Retrieves the tag pointed to by the oid * - * @static - * @param {Repository} repo - * @param {(string | Oid | Tag)} id - * @returns {Promise} * - * @memberof Tag */ static lookup(repo: Repository, id: string | Oid | Tag): Promise; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} id - * @param {number} len - * @returns {Promise} - * - * @memberof Tag - */ static lookupPrefix(repo: Repository, id: Oid, len: number): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof Tag - */ dup(): Promise; - /** - * - * - * - * @memberof Tag - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Tag - */ id(): Oid; - /** - * - * - * @returns {string} - * - * @memberof Tag - */ message(): string; - /** - * - * - * @returns {string} - * - * @memberof Tag - */ name(): string; - /** - * - * - * @returns {Repository} - * - * @memberof Tag - */ owner(): Repository; - /** - * - * - * @param {Object} tagTargetOut - * @returns {number} - * - * @memberof Tag - */ peel(tagTargetOut: Object): number; - /** - * - * - * @returns {Signature} - * - * @memberof Tag - */ tagger(): Signature; - /** - * - * - * @returns {Object} - * - * @memberof Tag - */ target(): Object; - /** - * - * - * @returns {Oid} - * - * @memberof Tag - */ targetId(): Oid; - /** - * - * - * @returns {number} - * - * @memberof Tag - */ targetType(): number; } diff --git a/types/nodegit/time.d.ts b/types/nodegit/time.d.ts index 299bcfa35e..575c005781 100644 --- a/types/nodegit/time.d.ts +++ b/types/nodegit/time.d.ts @@ -1,16 +1,4 @@ export class Time { - /** - * - * - * @type {number} - * @memberof Time - */ time: number; - /** - * - * - * @type {number} - * @memberof Time - */ offset: number; } diff --git a/types/nodegit/transfer-progress.d.ts b/types/nodegit/transfer-progress.d.ts index f4c0d21065..1589d4b6c6 100644 --- a/types/nodegit/transfer-progress.d.ts +++ b/types/nodegit/transfer-progress.d.ts @@ -1,51 +1,9 @@ export class TransferProgress { - /** - * - * - * @type {number} - * @memberof TransferProgress - */ totalObjects: number; - /** - * - * - * @type {number} - * @memberof TransferProgress - */ indexedObjects: number; - /** - * - * - * @type {number} - * @memberof TransferProgress - */ receivedObjects: number; - /** - * - * - * @type {number} - * @memberof TransferProgress - */ localObjects: number; - /** - * - * - * @type {number} - * @memberof TransferProgress - */ totalDeltas: number; - /** - * - * - * @type {number} - * @memberof TransferProgress - */ indexedDeltas: number; - /** - * - * - * @type {number} - * @memberof TransferProgress - */ receivedBytes: number; } diff --git a/types/nodegit/transport.d.ts b/types/nodegit/transport.d.ts index 01dd4312ef..4cdd39f400 100644 --- a/types/nodegit/transport.d.ts +++ b/types/nodegit/transport.d.ts @@ -9,45 +9,8 @@ export namespace Transport { } export class Transport { - /** - * å - * - * @static - * @param {Remote} owner - * @param {Strarray} payload - * @returns {Promise} - * - * @memberof Transport - */ static sshWithPaths(owner: Remote, payload: Strarray): Promise; - /** - * - * - * @static - * @param {string} prefix - * @returns {number} - * - * @memberof Transport - */ static unregister(prefix: string): number; - /** - * - * - * @param {number} version - * @returns {number} - * - * @memberof Transport - */ init(version: number): number; - /** - * - * - * @param {Cert} cert - * @param {number} valid - * @param {string} hostName - * @returns {number} - * - * @memberof Transport - */ smartCertificateCheck(cert: Cert, valid: number, hostName: string): number; } diff --git a/types/nodegit/tree-builder.d.ts b/types/nodegit/tree-builder.d.ts index 4c50cdbd65..f5a6715492 100644 --- a/types/nodegit/tree-builder.d.ts +++ b/types/nodegit/tree-builder.d.ts @@ -4,75 +4,12 @@ import { Tree } from './tree'; import { TreeEntry } from './tree-entry'; export class Treebuilder { - /** - * - * - * @static - * @param {Repository} repo - * @param {Tree} source - * @returns {Promise} - * - * @memberof Treebuilder - */ static create(repo: Repository, source: Tree): Promise; - - /** - * - * - * - * @memberof Treebuilder - */ clear(): void; - /** - * - * - * @returns {number} - * - * @memberof Treebuilder - */ entrycount(): number; - /** - * - * - * - * @memberof Treebuilder - */ free(): void; - /** - * - * - * @param {string} filename - * @returns {TreeEntry} - * - * @memberof Treebuilder - */ get(filename: string): TreeEntry; - /** - * - * - * @param {string} filename - * @param {Oid} id - * @param {number} filemode - * @returns {Promise} - * - * @memberof Treebuilder - */ insert(filename: string, id: Oid, filemode: number): Promise; - /** - * - * - * @param {string} filename - * @returns {number} - * - * @memberof Treebuilder - */ remove(filename: string): number; - /** - * - * - * @returns {Oid} - * - * @memberof Treebuilder - */ write(): Oid; } diff --git a/types/nodegit/tree-entry.d.ts b/types/nodegit/tree-entry.d.ts index 3cf20499d3..a5e68a6081 100644 --- a/types/nodegit/tree-entry.d.ts +++ b/types/nodegit/tree-entry.d.ts @@ -15,148 +15,34 @@ export namespace TreeEntry { } export class TreeEntry { - /** - * - * - * @returns {TreeEntry.FILEMODE} - * - * @memberof TreeEntry - */ filemode(): TreeEntry.FILEMODE; - /** - * - * - * @returns {TreeEntry.FILEMODE} - * - * @memberof TreeEntry - */ filemodeRaw(): TreeEntry.FILEMODE; - /** - * - * - * - * @memberof TreeEntry - */ free(): void; - /** - * - * - * @returns {Promise} - * - * @memberof TreeEntry - */ getBlob(): Promise; - /** - * - * - * @returns {Promise} - * - * @memberof TreeEntry - */ getTree(): Promise; - /** - * - * - * @returns {Oid} - * - * @memberof TreeEntry - */ id(): Oid; - /** - * - * - * @returns {boolean} - * - * @memberof TreeEntry - */ isBlob(): boolean; - /** - * - * - * @returns {boolean} - * - * @memberof TreeEntry - */ isFile(): boolean; - /** - * - * - * @returns {boolean} - * - * @memberof TreeEntry - */ isTree(): boolean; - /** - * - * - * @returns {boolean} - * - * @memberof TreeEntry - */ isDirectory(): boolean; - /** - * - * - * @returns {boolean} - * - * @memberof TreeEntry - */ isSubmodule(): boolean; /** * Retrieve the SHA for this TreeEntry. - * - * @returns {string} - * - * @memberof TreeEntry */ sha(): string; - /** - * - * - * @returns {string} - * - * @memberof TreeEntry - */ name(): string; /** * Retrieve the SHA for this TreeEntry. Alias for sha - * - * @returns {string} - * - * @memberof TreeEntry */ oid(): string; /** * Returns the path for this entry. - * - * @returns {string} - * - * @memberof TreeEntry */ path(): string; /** * Alias for path - * - * @returns {string} - * - * @memberof TreeEntry */ toString(): string; - /** - * - * - * @param {Repository} repo - * @returns {Object} - * - * @memberof TreeEntry - */ toObject(repo: Repository): Object; - /** - * - * - * @returns {number} - * - * @memberof TreeEntry - */ type(): number; } diff --git a/types/nodegit/tree-update.d.ts b/types/nodegit/tree-update.d.ts index f8834513f4..fde63d064e 100644 --- a/types/nodegit/tree-update.d.ts +++ b/types/nodegit/tree-update.d.ts @@ -1,32 +1,8 @@ import { Oid } from './oid'; export class TreeUpdate { - /** - * - * - * @type {number} - * @memberof TreeUpdate - */ action: number; - /** - * - * - * @type {number} - * @memberof TreeUpdate - */ filemode: number; - /** - * - * - * @type {Oid} - * @memberof TreeUpdate - */ id: Oid; - /** - * - * - * @type {string} - * @memberof TreeUpdate - */ path: string; } diff --git a/types/nodegit/tree.d.ts b/types/nodegit/tree.d.ts index 057d3b2907..fd2674a025 100644 --- a/types/nodegit/tree.d.ts +++ b/types/nodegit/tree.d.ts @@ -14,208 +14,61 @@ export namespace Tree { } export class Tree { - /** - * - * - * @static - * @param {TreeEntry} tree1 - * @param {TreeEntry} tree2 - * @returns {number} - * - * @memberof Tree - */ static entryCmp(tree1: TreeEntry, tree2: TreeEntry): number; - /** - * - * - * @static - * @param {TreeEntry} dest - * @param {TreeEntry} source - * @returns {number} - * - * @memberof Tree - */ static entryDup(dest: TreeEntry, source: TreeEntry): number; - /** - * - * - * @static - * @param {Repository} repo - * @param {Oid} id - * @param {number} len - * @returns {Promise} - * - * @memberof Tree - */ static lookupPrefix(repo: Repository, id: Oid, len: number): Promise; /** * Retrieves the tree pointed to by the oid - * - * @static - * @param {Repository} repo - * @param {(string | Oid | Tree)} id - * @param {Function} callback - * @returns {Promise} - * - * @memberof Tree */ static lookup(repo: Repository, id: string | Oid | Tree, callback: Function): Promise; - /** - * - * - * @param {Oid} id - * @returns {TreeEntry} - * - * @memberof Tree - */ entryById(id: Oid): TreeEntry; - /** - * - * - * @param {number} idx - * @returns {TreeEntry} - * - * @memberof Tree - */ _entryByIndex(idx: number): TreeEntry; /** * Get an entry by name; if the tree is a directory, the name is the filename. - * - * @param {string} name - * @returns {TreeEntry} - * - * @memberof Tree */ entryByName(name: string): TreeEntry; - /** - * - * - * @param {string} filename - * @returns {TreeEntry} - * - * @memberof Tree - */ _entryByName(filename: string): TreeEntry; - /** - * - * - * @param {string} path - * @returns {Promise} - * - * @memberof Tree - */ entryByPath(path: string): Promise; - /** - * - * - * @returns {number} - * - * @memberof Tree - */ entryCount(): number; - /** - * - * - * - * @memberof Tree - */ + free(): void; - /** - * - * - * @returns {Oid} - * - * @memberof Tree - */ id(): Oid; - /** - * - * - * @returns {Repository} - * - * @memberof Tree - */ owner(): Repository; /** * Diff two trees - * - * @param {Tree} tree - * @param {Function} callback - * @returns {Promise} - * - * @memberof Tree */ diff(tree: Tree, callback: Function): Promise; /** * Diff two trees with options - * - * @param {Tree} tree - * @param {Object} options - * @param {Function} callback - * @returns {Promise} - * - * @memberof Tree */ diffWithOptions(tree: Tree, options: Object, callback: Function): Promise; /** * Get an entry at the ith position. - * - * @param {number} i - * @returns {TreeEntry} - * - * @memberof Tree */ entryByIndex(i: number): TreeEntry; /** * Get an entry at a path. Unlike by name, this takes a fully qualified path, like /foo/bar/baz.javascript - * - * @param {string} filePath - * @returns {TreeEntry} - * - * @memberof Tree */ getEntry(filePath: string): TreeEntry; /** * Return an array of the entries in this tree (excluding its children). - * - * @returns {TreeEntry[]} - * - * @memberof Tree */ entries(): TreeEntry[]; /** * Recursively walk the tree in breadth-first order. Fires an event for each entry. - * - * @param {boolean} [blobsOnly] - * @returns {NodeJS.EventEmitter} - * - * @memberof Tree */ walk(blobsOnly?: boolean): NodeJS.EventEmitter; /** * Return the path of this tree, like /lib/foo/bar * - * @returns {string} * - * @memberof Tree */ path(): string; /** * Make builder. This is helpful for modifying trees. - * - * @returns {Treebuilder} - * - * @memberof Tree */ builder(): Treebuilder; - /** - * - * - * @returns {Promise} - * - * @memberof Tree - */ dup(): Promise; createUpdated(repo: Repository, nUpdates: number, updates: TreeUpdate): Promise; } diff --git a/types/nodegit/tslint.json b/types/nodegit/tslint.json index a62d0d4e68..0ec275bd05 100644 --- a/types/nodegit/tslint.json +++ b/types/nodegit/tslint.json @@ -1,6 +1,8 @@ { "extends": "dtslint/dt.json", "rules": { - "ban-types": false + // TODOs + "ban-types": false, + "no-unnecessary-class": false } }