Added documentation

This commit is contained in:
Dolan
2017-06-09 01:33:54 +01:00
parent edf46bc725
commit 21a5f52f75
16 changed files with 1038 additions and 14 deletions

View File

@@ -1,10 +1,46 @@
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;
}

View File

@@ -8,9 +8,44 @@ export namespace Hashsig {
}
export class Hashsig {
/**
*
*
* @static
* @param {string} buf
* @param {number} buflen
* @param {number} opts
* @returns {Promise<Hashsig>}
*
* @memberof Hashsig
*/
static create(buf: string, buflen: number, opts: number): Promise<Hashsig>;
/**
*
*
* @static
* @param {string} path
* @param {number} opts
* @returns {Promise<Hashsig>}
*
* @memberof Hashsig
*/
static createFromFile(path: string, opts: number): Promise<Hashsig>;
/**
*
*
* @param {Hashsig} b
* @returns {number}
*
* @memberof Hashsig
*/
compare(b: Hashsig): number;
/**
*
*
*
* @memberof Hashsig
*/
free(): void;
}

View File

@@ -1,21 +1,105 @@
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;
}

View File

@@ -21,36 +21,315 @@ 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} index_path
* @returns {Promise<Index>}
*
* @memberof Index
*/
static open(index_path: string): Promise<Index>;
/**
*
*
* @param {IndexEntry} source_entry
* @returns {number}
*
* @memberof Index
*/
add(source_entry: IndexEntry): number;
/**
*
*
* @param {Strarray} pathspec
* @param {number} flags
* @param {Function} callback
* @param {void} payload
* @returns {Promise<number>}
*
* @memberof Index
*/
addAll(pathspec: Strarray, flags: number, callback: Function, payload: void): Promise<number>;
/**
*
*
* @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} ancestor_entry
* @param {IndexEntry} our_entry
* @param {IndexEntry} their_entry
* @returns {number}
*
* @memberof Index
*/
conflictAdd(ancestor_entry: IndexEntry, our_entry: IndexEntry, their_entry: IndexEntry): number;
/**
*
*
* @returns {number}
*
* @memberof Index
*/
conflictCleanup(): number;
/**
*
*
* @param {string} path
* @returns {Promise<IndexEntry>}
*
* @memberof Index
*/
conflictGet(path: string): Promise<IndexEntry>;
/**
*
*
* @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<number>}
*
* @memberof Index
*/
removeAll(pathspec: Strarray, callback: Function, payload: void): Promise<number>;
/**
*
*
* @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<number>}
*
* @memberof Index
*/
updateAll(pathspec: Strarray, callback: Function, payload: void): Promise<number>;
/**
*
*
* @returns {number}
*
* @memberof Index
*/
write(): number;
/**
*
*
* @returns {Promise<Oid>}
*
* @memberof Index
*/
writeTree(): Promise<Oid>;
/**
*
*
* @param {Repository} repo
* @returns {Promise<Oid>}
*
* @memberof Index
*/
writeTreeTo(repo: Repository): Promise<Oid>;
/**
*
*
* @returns {IndexEntry[]}
*
* @memberof Index
*/
entries(): IndexEntry[];
/**
*
*
* @param {number} at_pos
* @param {string} prefix
* @returns {number}
*
* @memberof Index
*/
findPrefix(at_pos: number, prefix: string): number;
/**
*
*
* @param {number} version
* @returns {number}
*
* @memberof Index
*/
setVersion(version: number): number;
/**
*
*
* @returns {number}
*
* @memberof Index
*/
version(): number;
}

View File

@@ -2,7 +2,28 @@ 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;
}

View File

@@ -17,9 +17,52 @@ 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;
}

View File

@@ -1,7 +1,37 @@
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;
}

View File

@@ -1,8 +1,44 @@
export interface MergeFileOptions {
version: number;
ancestorLabel: string;
ourLabel: string;
theirLabel: string;
favor: number;
flags: number;
/**
*
*
* @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;
}

View File

@@ -1,7 +1,37 @@
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;
}

View File

@@ -1,8 +1,58 @@
export interface MergeOptions {
version: number;
treeFlags: number;
renameThreshold: number;
targetLimit: number;
fileFavor: number;
fileFlags: number;
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;
}

View File

@@ -49,11 +49,90 @@ 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<Oid>}
*
* @memberof Merge
*/
static base(repo: Repository, one: Oid, two: Oid): Promise<Oid>;
/**
*
*
* @static
* @param {Repository} repo
* @param {Oid} one
* @param {Oid} two
* @returns {Promise<Oidarray>}
*
* @memberof Merge
*/
static bases(repo: Repository, one: Oid, two: Oid): Promise<Oidarray>;
/**
*
*
* @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} ancestor_tree
* @param {Tree} our_tree
* @param {Tree} their_tree
* @param {MergeOptions} opts
* @returns {Promise<Index>}
*
* @memberof Merge
*/
static trees(repo: Repository, ancestor_tree: Tree, our_tree: Tree, their_tree: Tree, opts: MergeOptions): Promise<Index>;
}

View File

@@ -3,16 +3,122 @@ import {Signature} from './signature';
import {Oid} from './oid';
export class Note {
/**
*
*
* @static
* @param {Repository} repo
* @param {string} notes_ref
* @param {Signature} author
* @param {Signature} committer
* @param {Oid} oid
* @param {string} note
* @param {number} force
* @returns {Promise<Oid>}
*
* @memberof Note
*/
static create(repo: Repository, notes_ref: string, author: Signature, committer: Signature, oid: Oid, note: string, force: number): Promise<Oid>;
/**
*
*
* @static
* @param {Repository} repo
* @param {string} notes_ref
* @param {Function} note_cb
* @param {*} payload
* @returns {Promise<number>}
*
* @memberof Note
*/
static foreach(repo: Repository, notes_ref: string, note_cb: Function, payload: any): Promise<number>;
/**
*
*
* @static
* @param {Repository} repo
* @param {string} notes_ref
* @returns {Promise<any>}
*
* @memberof Note
*/
static iteratorNew(repo: Repository, notes_ref: string): Promise<any>;
/**
*
*
* @static
* @param {Oid} note_id
* @param {Oid} annotated_id
* @param {*} it
* @returns {number}
*
* @memberof Note
*/
static next(note_id: Oid, annotated_id: Oid, it: any): number;
/**
*
*
* @static
* @param {Repository} repo
* @param {string} notes_ref
* @param {Oid} oid
* @returns {Promise<Note>}
*
* @memberof Note
*/
static read(repo: Repository, notes_ref: string, oid: Oid): Promise<Note>;
/**
*
*
* @static
* @param {Repository} repo
* @param {string} notes_ref
* @param {Signature} author
* @param {Signature} committer
* @param {Oid} oid
* @returns {Promise<number>}
*
* @memberof Note
*/
static remove(repo: Repository, notes_ref: string, author: Signature, committer: Signature, oid: Oid): Promise<number>;
/**
*
*
* @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;
}

View File

@@ -3,19 +3,136 @@ 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<Object>}
*
* @memberof Object
*/
static lookup(repo: Repository, id: Oid, type: number): Promise<Object>;
/**
*
*
* @static
* @param {Repository} repo
* @param {Oid} id
* @param {number} len
* @param {number} type
* @returns {Promise<Object>}
*
* @memberof Object
*/
static lookupPrefix(repo: Repository, id: Oid, len: number, type: number): Promise<Object>;
/**
*
*
* @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<Object>}
*
* @memberof Object
*/
dup(): Promise<Object>;
/**
*
*
*
* @memberof Object
*/
free(): void;
/**
*
*
* @returns {Oid}
*
* @memberof Object
*/
id(): Oid;
/**
*
*
* @param {string} path
* @param {number} type
* @returns {Promise<Object>}
*
* @memberof Object
*/
lookupByPath(path: string, type: number): Promise<Object>;
/**
*
*
* @returns {Repository}
*
* @memberof Object
*/
owner(): Repository;
/**
*
*
* @param {number} target_type
* @returns {Promise<Object>}
*
* @memberof Object
*/
peel(target_type: number): Promise<Object>;
/**
*
*
* @returns {Promise<Buf>}
*
* @memberof Object
*/
shortId(): Promise<Buf>;
/**
*
*
* @returns {number}
*
* @memberof Object
*/
type(): number;
}

View File

@@ -1,10 +1,51 @@
import { Oid } from './oid';
export class OdbObject {
/**
*
*
* @returns {Buffer}
*
* @memberof OdbObject
*/
data(): Buffer;
/**
*
*
* @returns {Promise<OdbObject>}
*
* @memberof OdbObject
*/
dup(): Promise<OdbObject>;
/**
*
*
*
* @memberof OdbObject
*/
free(): void;
/**
*
*
* @returns {Oid}
*
* @memberof OdbObject
*/
id(): Oid;
/**
*
*
* @returns {number}
*
* @memberof OdbObject
*/
size(): number;
/**
*
*
* @returns {number}
*
* @memberof OdbObject
*/
type(): number;
}

View File

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

View File

@@ -1,8 +1,44 @@
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
}