mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-04 23:07:06 +00:00
Added more documentation
This commit is contained in:
Vendored
+142
-10
@@ -1,6 +1,7 @@
|
||||
import { Tree } from './tree';
|
||||
import { Oid } from './oid';
|
||||
import { Blob } from './blob';
|
||||
import { Repository } from './repository';
|
||||
|
||||
export namespace TreeEntry {
|
||||
const enum FILEMODE {
|
||||
@@ -14,17 +15,148 @@ export namespace TreeEntry {
|
||||
}
|
||||
|
||||
export class TreeEntry {
|
||||
isFile(): boolean;
|
||||
isTree(): boolean;
|
||||
isDirectory(): boolean;
|
||||
isBlob(): boolean;
|
||||
sha(): string;
|
||||
getTree(): Promise<Tree>;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @returns {TreeEntry.FILEMODE}
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
filemode(): TreeEntry.FILEMODE;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @returns {TreeEntry.FILEMODE}
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
filemodeRaw(): TreeEntry.FILEMODE;
|
||||
/**
|
||||
*
|
||||
*
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
free(): void;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @returns {Promise<Blob>}
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
getBlob(): Promise<Blob>;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @returns {Promise<Tree>}
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
getTree(): Promise<Tree>;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @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;
|
||||
attr: number;
|
||||
oid: Oid;
|
||||
filenameLen: number;
|
||||
filename: string;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @param {Repository} repo
|
||||
* @returns {Object}
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
toObject(repo: Repository): Object;
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @returns {number}
|
||||
*
|
||||
* @memberof TreeEntry
|
||||
*/
|
||||
type(): number;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user