| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent b9d2d7b commit c478a67
123 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,9 +3,18 @@ title: NodeGit | |||
| 3 | 3 | description: Asynchronous native Node bindings to libgit2 | |
| 4 | 4 | url: "http://nodegit.org" | |
| 5 | 5 | date_format: "ordinal" | |
| 6 | - current_nodegit_version: 0.21.1 | ||
| 6 | + current_nodegit_version: 0.24.0 | ||
| 7 | 7 | other_nodegit_versions: | |
| 8 | 8 | - HEAD | |
| 9 | + - 0.24.0 | ||
| 10 | + - 0.24.0-alpha.1 | ||
| 11 | + - 0.23.0 | ||
| 12 | + - 0.23.0-alpha.2 | ||
| 13 | + - 0.23.0-alpha.1 | ||
| 14 | + - 0.22.2 | ||
| 15 | + - 0.22.1 | ||
| 16 | + - 0.22.0 | ||
| 17 | + - 0.21.2 | ||
| 9 | 18 | - 0.21.1 | |
| 10 | 19 | - 0.21.0 | |
| 11 | 20 | - 0.20.3 | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,7 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: AnnotatedCommit | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
@@ -11,7 +11,6 @@ sections: | |||
| 11 | 11 | "fromRef": "#fromRef" | |
| 12 | 12 | "fromRevspec": "#fromRevspec" | |
| 13 | 13 | "lookup": "#lookup" | |
| 14 | - "#free": "#free" | ||
| 15 | 14 | "#id": "#id" | |
| 16 | 15 | --- | |
| 17 | 16 | ||
@@ -85,12 +84,6 @@ AnnotatedCommit.lookup(repo, id).then(function(annotatedCommit) { | |||
| 85 | 84 | | --- | --- | | |
| 86 | 85 | | [AnnotatedCommit](/api/annotated_commit/) | | | |
| 87 | 86 | ||
| 88 | - ## <a name="free"></a><span>AnnotatedCommit#</span>free <span class="tags"><span class="sync">Sync</span></span> | ||
| 89 | - | ||
| 90 | - ```js | ||
| 91 | - annotatedCommit.free(); | ||
| 92 | - ``` | ||
| 93 | - | ||
| 94 | 87 | ## <a name="id"></a><span>AnnotatedCommit#</span>id <span class="tags"><span class="sync">Sync</span></span> | |
| 95 | 88 | ||
| 96 | 89 | ```js | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,7 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: Attr | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
@@ -63,10 +63,12 @@ Attr.get(repo, flags, path, name).then(function(string) { | |||
| 63 | 63 | use the string value for attributes set to a value. You | |
| 64 | 64 | should NOT modify or free this value. | | |
| 65 | 65 | ||
| 66 | - ## <a name="getMany"></a><span>Attr.</span>getMany <span class="tags"><span class="sync">Sync</span></span> | ||
| 66 | + ## <a name="getMany"></a><span>Attr.</span>getMany <span class="tags"><span class="async">Async</span></span> | ||
| 67 | 67 | ||
| 68 | 68 | ```js | |
| 69 | - var array = Attr.getMany(repo, flags, path, num_attr, names); | ||
| 69 | + Attr.getMany(repo, flags, path, num_attr, names).then(function(array) { | ||
| 70 | + // Use array | ||
| 71 | + }); | ||
| 70 | 72 | ``` | |
| 71 | 73 | ||
| 72 | 74 | | Parameters | Type | | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,15 +2,13 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: Blame | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| 9 | 9 | sections: | |
| 10 | 10 | "file": "#file" | |
| 11 | - "initOptions": "#initOptions" | ||
| 12 | 11 | "#buffer": "#buffer" | |
| 13 | - "#free": "#free" | ||
| 14 | 12 | "#getHunkByIndex": "#getHunkByIndex" | |
| 15 | 13 | "#getHunkByLine": "#getHunkByLine" | |
| 16 | 14 | "#getHunkCount": "#getHunkCount" | |
@@ -32,21 +30,6 @@ Retrieve the blame of a file | |||
| 32 | 30 | | path | String | to the file to get the blame of | | |
| 33 | 31 | | [options] | [BlameOptions](/api/blame_options/) | Options for the blame | | |
| 34 | 32 | ||
| 35 | - ## <a name="initOptions"></a><span>Blame.</span>initOptions <span class="tags"><span class="sync">Sync</span></span> | ||
| 36 | - | ||
| 37 | - ```js | ||
| 38 | - var result = Blame.initOptions(opts, version); | ||
| 39 | - ``` | ||
| 40 | - | ||
| 41 | - | Parameters | Type | | | ||
| 42 | - | --- | --- | --- | | ||
| 43 | - | opts | [BlameOptions](/api/blame_options/) | The `git_blame_options` struct to initialize | | ||
| 44 | - | version | Number | Version of struct; pass `GIT_BLAME_OPTIONS_VERSION` | | ||
| 45 | - | ||
| 46 | - | Returns | | | ||
| 47 | - | --- | --- | | ||
| 48 | - | Number | Zero on success; -1 on failure. | | ||
| 49 | - | ||
| 50 | 33 | ## <a name="buffer"></a><span>Blame#</span>buffer <span class="tags"><span class="async">Async</span></span> | |
| 51 | 34 | ||
| 52 | 35 | ```js | |
@@ -64,12 +47,6 @@ blame.buffer(buffer, buffer_len).then(function(blame) { | |||
| 64 | 47 | | --- | --- | | |
| 65 | 48 | | [Blame](/api/blame/) | | | |
| 66 | 49 | ||
| 67 | - ## <a name="free"></a><span>Blame#</span>free <span class="tags"><span class="sync">Sync</span></span> | ||
| 68 | - | ||
| 69 | - ```js | ||
| 70 | - blame.free(); | ||
| 71 | - ``` | ||
| 72 | - | ||
| 73 | 50 | ## <a name="getHunkByIndex"></a><span>Blame#</span>getHunkByIndex <span class="tags"><span class="sync">Sync</span></span> | |
| 74 | 51 | ||
| 75 | 52 | ```js | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,7 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: BlameHunk | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,7 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: BlameOptions | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,23 +2,20 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: Blob | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| 9 | 9 | sections: | |
| 10 | 10 | "createFromBuffer": "#createFromBuffer" | |
| 11 | 11 | "createFromDisk": "#createFromDisk" | |
| 12 | - "createFromStream": "#createFromStream" | ||
| 13 | 12 | "createFromWorkdir": "#createFromWorkdir" | |
| 14 | - "createFromstreamCommit": "#createFromstreamCommit" | ||
| 15 | 13 | "filteredContent": "#filteredContent" | |
| 16 | 14 | "lookup": "#lookup" | |
| 17 | 15 | "lookupPrefix": "#lookupPrefix" | |
| 18 | 16 | "#content": "#content" | |
| 19 | 17 | "#dup": "#dup" | |
| 20 | 18 | "#filemode": "#filemode" | |
| 21 | - "#free": "#free" | ||
| 22 | 19 | "#id": "#id" | |
| 23 | 20 | "#isBinary": "#isBinary" | |
| 24 | 21 | "#owner": "#owner" | |
@@ -62,23 +59,6 @@ Blob.createFromDisk(repo, path).then(function(oid) { | |||
| 62 | 59 | | --- | --- | | |
| 63 | 60 | | [Oid](/api/oid/) | return the id of the written blob | | |
| 64 | 61 | ||
| 65 | - ## <a name="createFromStream"></a><span>Blob.</span>createFromStream <span class="tags"><span class="async">Async</span></span> | ||
| 66 | - | ||
| 67 | - ```js | ||
| 68 | - Blob.createFromStream(repo, hintpath).then(function(writestream) { | ||
| 69 | - // Use writestream | ||
| 70 | - }); | ||
| 71 | - ``` | ||
| 72 | - | ||
| 73 | - | Parameters | Type | | | ||
| 74 | - | --- | --- | --- | | ||
| 75 | - | repo | [Repository](/api/repository/) | Repository where the blob will be written. This repository can be bare or not. | | ||
| 76 | - | hintpath | String | If not NULL, will be used to select data filters to apply onto the content of the blob to be created. | | ||
| 77 | - | ||
| 78 | - | Returns | | | ||
| 79 | - | --- | --- | | ||
| 80 | - | [Writestream](/api/writestream/) | the stream into which to write | | ||
| 81 | - | ||
| 82 | 62 | ## <a name="createFromWorkdir"></a><span>Blob.</span>createFromWorkdir <span class="tags"><span class="async">Async</span></span> | |
| 83 | 63 | ||
| 84 | 64 | ```js | |
@@ -96,22 +76,6 @@ Blob.createFromWorkdir(repo, relative_path).then(function(oid) { | |||
| 96 | 76 | | --- | --- | | |
| 97 | 77 | | [Oid](/api/oid/) | return the id of the written blob | | |
| 98 | 78 | ||
| 99 | - ## <a name="createFromstreamCommit"></a><span>Blob.</span>createFromstreamCommit <span class="tags"><span class="async">Async</span></span> | ||
| 100 | - | ||
| 101 | - ```js | ||
| 102 | - Blob.createFromstreamCommit(stream).then(function(oid) { | ||
| 103 | - // Use oid | ||
| 104 | - }); | ||
| 105 | - ``` | ||
| 106 | - | ||
| 107 | - | Parameters | Type | | | ||
| 108 | - | --- | --- | --- | | ||
| 109 | - | stream | [Writestream](/api/writestream/) | the stream to close | | ||
| 110 | - | ||
| 111 | - | Returns | | | ||
| 112 | - | --- | --- | | ||
| 113 | - | [Oid](/api/oid/) | the id of the new blob | | ||
| 114 | - | ||
| 115 | 79 | ## <a name="filteredContent"></a><span>Blob.</span>filteredContent <span class="tags"><span class="async">Async</span></span> | |
| 116 | 80 | ||
| 117 | 81 | ```js | |
@@ -203,12 +167,6 @@ Retrieve the Blob's type. | |||
| 203 | 167 | | --- | --- | | |
| 204 | 168 | | Number | The filemode of the blob. | | |
| 205 | 169 | ||
| 206 | - ## <a name="free"></a><span>Blob#</span>free <span class="tags"><span class="sync">Sync</span></span> | ||
| 207 | - | ||
| 208 | - ```js | ||
| 209 | - blob.free(); | ||
| 210 | - ``` | ||
| 211 | - | ||
| 212 | 170 | ## <a name="id"></a><span>Blob#</span>id <span class="tags"><span class="sync">Sync</span></span> | |
| 213 | 171 | ||
| 214 | 172 | ```js | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,16 +2,16 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: Branch | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| 9 | 9 | sections: | |
| 10 | 10 | "create": "#create" | |
| 11 | 11 | "createFromAnnotated": "#createFromAnnotated" | |
| 12 | 12 | "delete": "#delete" | |
| 13 | + "isCheckedOut": "#isCheckedOut" | ||
| 13 | 14 | "isHead": "#isHead" | |
| 14 | - "iteratorNew": "#iteratorNew" | ||
| 15 | 15 | "lookup": "#lookup" | |
| 16 | 16 | "move": "#move" | |
| 17 | 17 | "name": "#name" | |
@@ -73,37 +73,35 @@ var result = Branch.delete(branch); | |||
| 73 | 73 | | --- | --- | | |
| 74 | 74 | | Number | 0 on success, or an error code. | | |
| 75 | 75 | ||
| 76 | - ## <a name="isHead"></a><span>Branch.</span>isHead <span class="tags"><span class="sync">Sync</span></span> | ||
| 76 | + ## <a name="isCheckedOut"></a><span>Branch.</span>isCheckedOut <span class="tags"><span class="sync">Sync</span></span> | ||
| 77 | 77 | ||
| 78 | 78 | ```js | |
| 79 | - var result = Branch.isHead(branch); | ||
| 79 | + var result = Branch.isCheckedOut(branch); | ||
| 80 | 80 | ``` | |
| 81 | 81 | ||
| 82 | 82 | | Parameters | Type | | | |
| 83 | 83 | | --- | --- | --- | | |
| 84 | - | branch | [Reference](/api/reference/) | Current underlying reference of the branch. | | ||
| 84 | + | branch | [Reference](/api/reference/) | Reference to the branch. | | ||
| 85 | 85 | ||
| 86 | 86 | | Returns | | | |
| 87 | 87 | | --- | --- | | |
| 88 | - | Number | 1 if HEAD points at the branch, 0 if it isn't, | ||
| 88 | + | Number | 1 if branch is checked out, 0 if it isn't, | ||
| 89 | 89 | error code otherwise. | | |
| 90 | 90 | ||
| 91 | - ## <a name="iteratorNew"></a><span>Branch.</span>iteratorNew <span class="tags"><span class="async">Async</span></span> | ||
| 91 | + ## <a name="isHead"></a><span>Branch.</span>isHead <span class="tags"><span class="sync">Sync</span></span> | ||
| 92 | 92 | ||
| 93 | 93 | ```js | |
| 94 | - Branch.iteratorNew(repo, list_flags).then(function(branchIterator) { | ||
| 95 | - // Use branchIterator | ||
| 96 | - }); | ||
| 94 | + var result = Branch.isHead(branch); | ||
| 97 | 95 | ``` | |
| 98 | 96 | ||
| 99 | 97 | | Parameters | Type | | | |
| 100 | 98 | | --- | --- | --- | | |
| 101 | - | repo | [Repository](/api/repository/) | Repository where to find the branches. | | ||
| 102 | - | list_flags | Number | Filtering flags for the branch listing. Valid values are GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE or GIT_BRANCH_ALL. | | ||
| 99 | + | branch | [Reference](/api/reference/) | Current underlying reference of the branch. | | ||
| 103 | 100 | ||
| 104 | 101 | | Returns | | | |
| 105 | 102 | | --- | --- | | |
| 106 | - | [BranchIterator](/api/branch_iterator/) | the iterator | | ||
| 103 | + | Number | 1 if HEAD points at the branch, 0 if it isn't, | ||
| 104 | + error code otherwise. | | ||
| 107 | 105 | ||
| 108 | 106 | ## <a name="lookup"></a><span>Branch.</span>lookup <span class="tags"><span class="async">Async</span></span> | |
| 109 | 107 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,13 +2,12 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: Buf | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| 9 | 9 | sections: | |
| 10 | 10 | "#containsNul": "#containsNul" | |
| 11 | - "#free": "#free" | ||
| 12 | 11 | "#grow": "#grow" | |
| 13 | 12 | "#isBinary": "#isBinary" | |
| 14 | 13 | "#set": "#set" | |
@@ -25,12 +24,6 @@ var result = buf.containsNul(); | |||
| 25 | 24 | | --- | --- | | |
| 26 | 25 | | Number | 1 if buffer contains a NUL byte | | |
| 27 | 26 | ||
| 28 | - ## <a name="free"></a><span>Buf#</span>free <span class="tags"><span class="sync">Sync</span><span class="experimental">Experimental</span></span> | ||
| 29 | - | ||
| 30 | - ```js | ||
| 31 | - buf.free(); | ||
| 32 | - ``` | ||
| 33 | - | ||
| 34 | 27 | ## <a name="grow"></a><span>Buf#</span>grow <span class="tags"><span class="async">Async</span><span class="experimental">Experimental</span></span> | |
| 35 | 28 | ||
| 36 | 29 | ```js | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,7 +2,7 @@ | |||
| 2 | 2 | layout: default | |
| 3 | 3 | menu_item: api | |
| 4 | 4 | title: Cert | |
| 5 | - description: Version 0.19.0 | ||
| 5 | + description: Version 0.24.0 | ||
| 6 | 6 | menu_item: api | |
| 7 | 7 | return_to: | |
| 8 | 8 | "API Documentation Index": /api/ | |
| Back | FazBrowse Home | New Git URL |
0 commit comments