-
Notifications
You must be signed in to change notification settings - Fork 0
/
data.json
630 lines (630 loc) · 21.1 KB
/
data.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
{
"project": {
"name": "GitHub Git Data API Client",
"description": "Presents an object-oriented interface for dealing with git branches, commits, trees, and blobs. Uses the GitHub Git Data API.",
"version": "0.0.1",
"url": "http://github.com/rhyolight/github-data/"
},
"files": {
"lib/blob.js": {
"name": "lib/blob.js",
"modules": {},
"classes": {
"Blob": 1
},
"fors": {},
"namespaces": {}
},
"lib/branch.js": {
"name": "lib/branch.js",
"modules": {},
"classes": {
"Branch": 1
},
"fors": {},
"namespaces": {}
},
"lib/commit.js": {
"name": "lib/commit.js",
"modules": {},
"classes": {
"Commit": 1
},
"fors": {},
"namespaces": {}
},
"lib/gitdata.js": {
"name": "lib/gitdata.js",
"modules": {},
"classes": {
"GitData": 1
},
"fors": {},
"namespaces": {}
},
"lib/tree.js": {
"name": "lib/tree.js",
"modules": {},
"classes": {
"Tree": 1
},
"fors": {},
"namespaces": {}
}
},
"modules": {},
"classes": {
"Blob": {
"name": "Blob",
"shortname": "Blob",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"file": "lib/blob.js",
"line": 1,
"description": "A git blob object.",
"params": [
{
"name": "source",
"description": "JSON response from API, used to build.",
"type": "Object"
},
{
"name": "parent",
"description": "Expected to be {{#crossLink \"Tree\"}}{{/crossLink}}.",
"type": "Object"
},
{
"name": "githubClient",
"description": "GitHub API Client object.",
"type": "Object"
}
],
"is_constructor": 1
},
"Branch": {
"name": "Branch",
"shortname": "Branch",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"file": "lib/branch.js",
"line": 4,
"description": "Represents a git \"reference\", but it makes more sense in the context of this\nlibrary to call it a branch. This constructor is not meant to be called\nmanually. It is created by the {{#crossLink \"GitData\"}}{{/crossLink}} object.",
"params": [
{
"name": "source",
"description": "JSON response from API, used to build.",
"type": "Object"
},
{
"name": "githubClient",
"description": "GitHub API Client object.",
"type": "Object"
}
],
"is_constructor": 1
},
"Commit": {
"name": "Commit",
"shortname": "Commit",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"file": "lib/commit.js",
"line": 3,
"description": "A git commit object. Contains a tree.",
"params": [
{
"name": "source",
"description": "JSON response from API, used to build.",
"type": "Object"
},
{
"name": "githubClient",
"description": "GitHub API Client object.",
"type": "Object"
}
],
"is_constructor": 1
},
"GitData": {
"name": "GitData",
"shortname": "GitData",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"file": "lib/gitdata.js",
"line": 5,
"description": "Interface to the GitHub Git Data API (https://developer.github.com/v3/git/).\nBuilds on top of the excellent Node.js GitHub API client\nhttps://github.com/mikedeboer/node-github.",
"params": [
{
"name": "username",
"description": "GitHub username.",
"type": "String"
},
{
"name": "password",
"description": "GitHub password.",
"type": "String"
},
{
"name": "organization",
"description": "GitHub organization.",
"type": "String"
},
{
"name": "repository",
"description": "GitHub repository.",
"type": "String"
}
],
"is_constructor": 1
},
"Tree": {
"name": "Tree",
"shortname": "Tree",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"file": "lib/tree.js",
"line": 12,
"description": "A git tree object.",
"params": [
{
"name": "source",
"description": "JSON response from API, used to build.",
"type": "Object"
},
{
"name": "parent",
"description": "Expected to be {{#crossLink \"Tree\"}}{{/crossLink}} or\n {{#crossLink \"Commit\"}}{{/crossLink}}.",
"type": "Object"
},
{
"name": "githubClient",
"description": "GitHub API Client object.",
"type": "Object"
}
],
"is_constructor": 1
}
},
"classitems": [
{
"file": "lib/blob.js",
"line": 18,
"description": "Gets utf-8 contents of blob.",
"itemtype": "method",
"name": "getContents",
"return": {
"description": "",
"type": "String"
},
"class": "Blob"
},
{
"file": "lib/blob.js",
"line": 27,
"description": "Sets utf-8 contents of blob.",
"itemtype": "method",
"name": "setContents",
"params": [
{
"name": "contents",
"description": "",
"type": "String"
}
],
"class": "Blob"
},
{
"file": "lib/blob.js",
"line": 36,
"description": "Checks to see if this blob object is dirty and its contents are different\nfrom those returned from the GitHub Git Data API when it was originally\ncreated.",
"itemtype": "method",
"name": "hasContentsChanged",
"return": {
"description": "",
"type": "Boolean"
},
"class": "Blob"
},
{
"file": "lib/blob.js",
"line": 51,
"description": "Posts a new blob object with this blob's current contents and returns the\nresponse data from the API. This function does not create a\n{{#crossLink \"Blob\"}}{{/crossLink}} object.",
"itemtype": "method",
"name": "update",
"params": [
{
"name": "callback",
"description": ""
}
],
"class": "Blob"
},
{
"file": "lib/blob.js",
"line": 78,
"description": "Returns a string detailing this Blob object, including sha, size, and\ncontents.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "",
"type": "String"
},
"class": "Blob"
},
{
"file": "lib/branch.js",
"line": 20,
"description": "Fetches the commit for this branch.",
"itemtype": "method",
"name": "getCommit",
"params": [
{
"name": "callback",
"description": "Called with (Error, {{#crossLink \"Commit\"}}{{/crossLink}})",
"type": "Function"
}
],
"class": "Branch"
},
{
"file": "lib/branch.js",
"line": 41,
"description": "Pushes a commit to this branch. Actually, it updates the reference object\nthis branch represents to point to the commit SHA of the given commit. Once\nit successfully calls the API to do so, it updates its own SHA to point to\nthe new commit SHA.",
"itemtype": "method",
"name": "push",
"params": [
{
"name": "commit",
"description": ""
},
{
"name": "callback",
"description": ""
}
],
"class": "Branch"
},
{
"file": "lib/branch.js",
"line": 82,
"description": "Returns string description of this branch reference, including sha and ref.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "",
"type": "String"
},
"class": "Branch"
},
{
"file": "lib/commit.js",
"line": 21,
"description": "Fetches the {{#crossLink \"Tree\"}}{{/crossLink}} corresponding to this commit.",
"itemtype": "method",
"name": "getTree",
"params": [
{
"name": "callback",
"description": "Called with (Error, {{#crossLink \"Tree\"}}{{/crossLink}})",
"type": "Function"
}
],
"class": "Commit"
},
{
"file": "lib/commit.js",
"line": 43,
"description": "Creates a new Commit given a Tree object.",
"itemtype": "method",
"name": "commitTree",
"params": [
{
"name": "tree",
"description": "Tree that contains changes to commit.",
"type": "Tree"
},
{
"name": "message",
"description": "Commit message.",
"type": "String"
},
{
"name": "callback",
"description": "Called with new commit (Error, Commit).",
"type": "Function"
}
],
"class": "Commit"
},
{
"file": "lib/commit.js",
"line": 91,
"description": "Returns string data about this commit, similar to what git log would show.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "",
"type": "String"
},
"class": "Commit"
},
{
"file": "lib/gitdata.js",
"line": 48,
"description": "Fetches branch data and converts it into a\n{{#crossLink \"Branch\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "getBranch",
"params": [
{
"name": "name",
"description": "Name of branch to fetch.",
"type": "String"
},
{
"name": "callback",
"description": "Called with (Error, {{#crossLink \"Branch\"}}{{/crossLink}}).",
"type": "Function"
}
],
"class": "GitData"
},
{
"file": "lib/tree.js",
"line": 30,
"description": "Gets list of objects within the tree.",
"itemtype": "method",
"name": "getObjects",
"return": {
"description": "",
"type": "Array"
},
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 39,
"description": "Gets details about an object given its path.",
"itemtype": "method",
"name": "getObjectDataByPath",
"params": [
{
"name": "path",
"description": "path to object",
"type": "String"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 51,
"description": "Checks to see if this tree object is dirty, meaning the tree objects have\nbeen manually changed since being retrieved from the API.",
"itemtype": "method",
"name": "hasChanged",
"return": {
"description": "",
"type": "Boolean"
},
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 61,
"description": "Checks if path points to a {{#crossLink \"Tree\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "isTree",
"params": [
{
"name": "path",
"description": "Path to an object within the tree.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 75,
"description": "Checks if path points to a {{#crossLink \"Blob\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "isBlob",
"params": [
{
"name": "path",
"description": "Path to an object within the tree.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 89,
"description": "This function takes a path, assuming it contains more than one level, and\ngets the top level Tree object and calls an \"operation\" on it (probably\neither 'getTree' or 'getBlob'), calling the callback function with the\nresult. This is useful for navigating down tree chains.",
"params": [
{
"name": "path",
"description": "Complex path (more than just one directory or file)",
"type": "String"
},
{
"name": "operation",
"description": "Name of function to call on resulting Tree",
"type": "String"
},
{
"name": "callback",
"description": "Called with result of operation (Error, Object)",
"type": "Function"
}
],
"access": "private",
"tagname": "",
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 120,
"description": "Fetches a {{#crossLink \"Tree\"}}{{/crossLink}}, given a path.",
"itemtype": "method",
"name": "getTree",
"params": [
{
"name": "path",
"description": "Path to the tree.",
"type": "String"
},
{
"name": "callback",
"description": "Called with (Error, {{#crossLink \"Tree\"}}{{/crossLink}})",
"type": "Function"
}
],
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 158,
"description": "Fetches a {{#crossLink \"Blob\"}}{{/crossLink}}, given a path. This function\nwill traverse subtrees to get to the blob if necessary. If it does, the Blob\nobject passed back may not have this tree as its parent, but the subtree\nimmediately above it.",
"itemtype": "method",
"name": "getBlob",
"params": [
{
"name": "path",
"description": "Path to the blob.",
"type": "String"
},
{
"name": "callback",
"description": "Called with (Error, {{#crossLink \"Blob\"}}{{/crossLink}})",
"type": "Function"
}
],
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 200,
"description": "Updates own object listing with new SHA for given blob path.",
"itemtype": "method",
"name": "setBlob",
"params": [
{
"name": "path",
"description": "path to blob",
"type": "String"
},
{
"name": "sha",
"description": "SHA",
"type": "String"
}
],
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 218,
"description": "Creates a new Tree object given the current state of this tree. Returns an\nerror if this tree's contents have not changed.",
"itemtype": "method",
"name": "update",
"params": [
{
"name": "callback",
"description": "Called with new Tree object (Error, Tree)",
"type": "Function"
}
],
"class": "Tree"
},
{
"file": "lib/tree.js",
"line": 243,
"description": "Returns string representation of the Tree object, including all objects\nwithin the Tree.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "",
"type": "String"
},
"class": "Tree"
}
],
"warnings": [
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/blob.js:18"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/blob.js:36"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/blob.js:78"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/branch.js:82"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/commit.js:91"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/tree.js:30"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/tree.js:39"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/tree.js:51"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/tree.js:61"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/tree.js:75"
},
{
"message": "replacing incorrect tag: returns with return",
"line": " lib/tree.js:243"
},
{
"message": "Missing item type\nThis function takes a path, assuming it contains more than one level, and\ngets the top level Tree object and calls an \"operation\" on it (probably\neither 'getTree' or 'getBlob'), calling the callback function with the\nresult. This is useful for navigating down tree chains.",
"line": " lib/tree.js:89"
}
]
}