repository-provider 26.0.0 → 26.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -66,11 +66,13 @@ console.log(await readme.getString());
66
66
  * [equals](#equals)
67
67
  * [Parameters](#parameters-8)
68
68
  * [attributes](#attributes)
69
+ * [writableAttributes](#writableattributes)
69
70
  * [attributeMapping](#attributemapping)
70
71
  * [description](#description)
71
72
  * [id](#id)
72
73
  * [uuid](#uuid)
73
74
  * [avatarURL](#avatarurl)
75
+ * [homePageURL](#homepageurl)
74
76
  * [MessageDestination](#messagedestination)
75
77
  * [Parameters](#parameters-9)
76
78
  * [BaseProvider](#baseprovider)
@@ -93,7 +95,7 @@ console.log(await readme.getString());
93
95
  * [Parameters](#parameters-16)
94
96
  * [projects](#projects)
95
97
  * [Parameters](#parameters-17)
96
- * [projects](#projects-1)
98
+ * [milestones](#milestones)
97
99
  * [Parameters](#parameters-18)
98
100
  * [repositories](#repositories)
99
101
  * [Parameters](#parameters-19)
@@ -178,6 +180,7 @@ console.log(await readme.getString());
178
180
  * [equals](#equals-3)
179
181
  * [Parameters](#parameters-45)
180
182
  * [displayName](#displayname)
183
+ * [update](#update)
181
184
  * [toJSON](#tojson-2)
182
185
  * [Project](#project)
183
186
  * [Parameters](#parameters-46)
@@ -209,6 +212,8 @@ console.log(await readme.getString());
209
212
  * [locked](#locked)
210
213
  * [merged](#merged)
211
214
  * [draft](#draft)
215
+ * [ContentEntry](#contententry)
216
+ * [Properties](#properties-9)
212
217
  * [Ref](#ref)
213
218
  * [Parameters](#parameters-52)
214
219
  * [equals](#equals-5)
@@ -229,7 +234,7 @@ console.log(await readme.getString());
229
234
  * [fullCondensedName](#fullcondensedname)
230
235
  * [identifier](#identifier-1)
231
236
  * [issuesURL](#issuesurl)
232
- * [homePageURL](#homepageurl)
237
+ * [homePageURL](#homepageurl-1)
233
238
  * [isLocked](#islocked)
234
239
  * [isArchived](#isarchived)
235
240
  * [isDisabled](#isdisabled)
@@ -239,7 +244,7 @@ console.log(await readme.getString());
239
244
  * [isProtected](#isprotected-1)
240
245
  * [RepositoryGroup](#repositorygroup-1)
241
246
  * [Parameters](#parameters-58)
242
- * [Properties](#properties-9)
247
+ * [Properties](#properties-10)
243
248
  * [repositoryClass](#repositoryclass-1)
244
249
  * [branchClass](#branchclass-1)
245
250
  * [contentClass](#contentclass)
@@ -252,7 +257,7 @@ console.log(await readme.getString());
252
257
  * [Parameters](#parameters-59)
253
258
  * [Repository](#repository-2)
254
259
  * [Parameters](#parameters-60)
255
- * [Properties](#properties-10)
260
+ * [Properties](#properties-11)
256
261
  * [fullName](#fullname-2)
257
262
  * [slug](#slug)
258
263
  * [provider](#provider-3)
@@ -269,13 +274,12 @@ console.log(await readme.getString());
269
274
  * [url](#url-4)
270
275
  * [cloneURL](#cloneurl)
271
276
  * [issuesURL](#issuesurl-1)
272
- * [homePageURL](#homepageurl-1)
277
+ * [homePageURL](#homepageurl-2)
273
278
  * [condensedName](#condensedname)
274
279
  * [isArchived](#isarchived-1)
275
280
  * [isLocked](#islocked-1)
276
281
  * [isDisabled](#isdisabled-1)
277
282
  * [isTemplate](#istemplate)
278
- * [update](#update)
279
283
  * [branch](#branch-1)
280
284
  * [Parameters](#parameters-65)
281
285
  * [defaultBranch](#defaultbranch)
@@ -320,7 +324,6 @@ console.log(await readme.getString());
320
324
  * [attributes](#attributes-2)
321
325
  * [defaultBranchName](#defaultbranchname)
322
326
  * [urls](#urls-1)
323
- * [homePageURL](#homepageurl-2)
324
327
  * [issuesURL](#issuesurl-2)
325
328
  * [Review](#review)
326
329
  * [SingleGroupProvider](#singlegroupprovider)
@@ -361,6 +364,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
361
364
  * `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
362
365
  * `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
363
366
  * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
367
+ * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
364
368
 
365
369
  ## definePropertiesFromOptions
366
370
 
@@ -423,7 +427,7 @@ In other words only produce key value pairs if value is defined.
423
427
 
424
428
  * `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
425
429
  * `initial` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
426
- * `skip` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** keys not to put in the result (optional, default `[]`)
430
+ * `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to operator on (optional, default `object.constructor.attributes`)
427
431
 
428
432
  Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** initial + defined values
429
433
 
@@ -460,7 +464,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
460
464
  ### Parameters
461
465
 
462
466
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
463
- * `additionalProperties`
467
+ * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
464
468
 
465
469
  ### equals
466
470
 
@@ -474,7 +478,11 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
474
478
 
475
479
  ### attributes
476
480
 
477
- options
481
+ Attributes definitions
482
+
483
+ ### writableAttributes
484
+
485
+ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** writable attributes
478
486
 
479
487
  ### attributeMapping
480
488
 
@@ -506,6 +514,12 @@ Avatar.
506
514
 
507
515
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
508
516
 
517
+ ## homePageURL
518
+
519
+ The url of home page.
520
+
521
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
522
+
509
523
  ## MessageDestination
510
524
 
511
525
  Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -625,9 +639,9 @@ List projects.
625
639
 
626
640
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
627
641
 
628
- Returns **Iterator\<Projects>** all matching projects of the provider
642
+ Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
629
643
 
630
- ### projects
644
+ ### milestones
631
645
 
632
646
  List milestones.
633
647
 
@@ -635,7 +649,7 @@ List milestones.
635
649
 
636
650
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
637
651
 
638
- Returns **Iterator<[Milestone](#milestone)>** all matching milestones of the provider
652
+ Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
639
653
 
640
654
  ### repositories
641
655
 
@@ -645,7 +659,7 @@ List repositories.
645
659
 
646
660
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
647
661
 
648
- Returns **Iterator<[Repository](#repository)>** all matching repos of the provider
662
+ Returns **AsyncIterator<[Repository](#repository)>** all matching repos of the provider
649
663
 
650
664
  ### branches
651
665
 
@@ -655,7 +669,7 @@ List branches.
655
669
 
656
670
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
657
671
 
658
- Returns **Iterator<[Branch](#branch)>** all matching branches of the provider
672
+ Returns **AsyncIterator<[Branch](#branch)>** all matching branches of the provider
659
673
 
660
674
  ### tags
661
675
 
@@ -665,7 +679,7 @@ List tags.
665
679
 
666
680
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
667
681
 
668
- Returns **Iterator<[Tag](#tag)>** all matching tags of the provider
682
+ Returns **AsyncIterator<[Tag](#tag)>** all matching tags of the provider
669
683
 
670
684
  ### hooks
671
685
 
@@ -675,7 +689,7 @@ List hooks.
675
689
 
676
690
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
677
691
 
678
- Returns **Iterator<[Hook](#hook)>** all matching hooks of the provider
692
+ Returns **AsyncIterator<[Hook](#hook)>** all matching hooks of the provider
679
693
 
680
694
  ### pullRequests
681
695
 
@@ -685,7 +699,7 @@ List pull requests.
685
699
 
686
700
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
687
701
 
688
- Returns **Iterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
702
+ Returns **AsyncIterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
689
703
 
690
704
  ### repositoryGroupClass
691
705
 
@@ -705,7 +719,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
705
719
 
706
720
  We are our own provider.
707
721
 
708
- Returns **Provider** this
722
+ Returns **[BaseProvider](#baseprovider)** this
709
723
 
710
724
  ### url
711
725
 
@@ -769,7 +783,7 @@ Creates a new provider for a given set of options.
769
783
  * `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**
770
784
  * `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
771
785
 
772
- Returns **Provider** newly created provider or undefined if options are not sufficient to construct a provider
786
+ Returns **[BaseProvider](#baseprovider)** newly created provider or undefined if options are not sufficient to construct a provider
773
787
 
774
788
  ## priority
775
789
 
@@ -791,7 +805,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
791
805
  ### Properties
792
806
 
793
807
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
794
- * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>**
808
+ * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>**
795
809
 
796
810
  ## Commit
797
811
 
@@ -851,7 +865,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
851
865
 
852
866
  Delete the branch from the [Repository](#repository).
853
867
 
854
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**
868
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
855
869
 
856
870
  ### commit
857
871
 
@@ -860,10 +874,10 @@ Commit entries.
860
874
  #### Parameters
861
875
 
862
876
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
863
- * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
877
+ * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** content to be commited
864
878
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
865
879
 
866
- Returns **[CommitResult](#commitresult)**
880
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>**
867
881
 
868
882
  ### commitIntoPullRequest
869
883
 
@@ -879,7 +893,7 @@ Add commits into a pull request.
879
893
  * `options.skipWithoutCommits` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a PR if no commits are given
880
894
  * `options.bodyFromCommitMessages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** generate body from commit messages
881
895
 
882
- Returns **[PullRequest](#pullrequest)**
896
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
883
897
 
884
898
  ### removeEntries
885
899
 
@@ -887,7 +901,7 @@ Remove entries form the branch.
887
901
 
888
902
  #### Parameters
889
903
 
890
- * `entries` **Iterator\<ContentEntry>**
904
+ * `entries` **AsyncIterator<[ContentEntry](#contententry)>**
891
905
 
892
906
  ### entryClass
893
907
 
@@ -995,7 +1009,7 @@ Lookup a repository in the provider and all of its repository groups.
995
1009
 
996
1010
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
997
1011
 
998
- Returns **[Repository](#repository)**
1012
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
999
1013
 
1000
1014
  ### repositoryGroup
1001
1015
 
@@ -1005,7 +1019,7 @@ Lookup a repository group.
1005
1019
 
1006
1020
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1007
1021
 
1008
- Returns **[RepositoryGroup](#repositorygroup)**
1022
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**
1009
1023
 
1010
1024
  ### repositoryGroups
1011
1025
 
@@ -1015,7 +1029,7 @@ List groups.
1015
1029
 
1016
1030
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
1017
1031
 
1018
- Returns **Iterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
1032
+ Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
1019
1033
 
1020
1034
  ### createRepositoryGroup
1021
1035
 
@@ -1027,7 +1041,7 @@ If there is already a group for the given name it will be returend instead
1027
1041
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1028
1042
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1029
1043
 
1030
- Returns **[RepositoryGroup](#repositorygroup)**
1044
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**
1031
1045
 
1032
1046
  ### addRepositoryGroup
1033
1047
 
@@ -1050,7 +1064,7 @@ Object with a name.
1050
1064
 
1051
1065
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1052
1066
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1053
- * `additionalProperties`
1067
+ * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1054
1068
 
1055
1069
  ### Properties
1056
1070
 
@@ -1072,6 +1086,10 @@ Beatified name use for human displaying only.
1072
1086
 
1073
1087
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
1074
1088
 
1089
+ ### update
1090
+
1091
+ Save object attributes in the backing store.
1092
+
1075
1093
  ### toJSON
1076
1094
 
1077
1095
  Provide name and all defined attributes.
@@ -1134,7 +1152,7 @@ Returns **[Repository](#repository)** destination repository
1134
1152
 
1135
1153
  ### provider
1136
1154
 
1137
- Returns **Provider**
1155
+ Returns **[BaseProvider](#baseprovider)**
1138
1156
 
1139
1157
  ### equals
1140
1158
 
@@ -1168,7 +1186,7 @@ Decline the pull request.
1168
1186
 
1169
1187
  ### reviews
1170
1188
 
1171
- Returns **Interaor<[Review](#review)>**
1189
+ Returns **AsyncIterator<[Review](#review)>**
1172
1190
 
1173
1191
  ### identifier
1174
1192
 
@@ -1208,7 +1226,7 @@ result will be filtered by source branch, destination branch and states
1208
1226
  * `filter.destination` **[Branch](#branch)?**
1209
1227
  * `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**
1210
1228
 
1211
- Returns **Iterator<[PullRequest](#pullrequest)>**
1229
+ Returns **AsyncIterator<[PullRequest](#pullrequest)>**
1212
1230
 
1213
1231
  ### open
1214
1232
 
@@ -1260,6 +1278,14 @@ Draft state of the pull request.
1260
1278
 
1261
1279
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
1262
1280
 
1281
+ ## ContentEntry
1282
+
1283
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1284
+
1285
+ ### Properties
1286
+
1287
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1288
+
1263
1289
  ## Ref
1264
1290
 
1265
1291
  **Extends NamedObject**
@@ -1278,13 +1304,13 @@ Check for equality.
1278
1304
 
1279
1305
  #### Parameters
1280
1306
 
1281
- * `other` **[Branch](#branch)**
1307
+ * `other` **[Ref](#ref)**
1282
1308
 
1283
1309
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name and repository are equal
1284
1310
 
1285
1311
  ### ref
1286
1312
 
1287
- ref name
1313
+ ref name.
1288
1314
 
1289
1315
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** git ref of the Ref
1290
1316
 
@@ -1296,7 +1322,7 @@ Get sha of a ref.
1296
1322
 
1297
1323
  * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `this.ref`)
1298
1324
 
1299
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** sha of the ref
1325
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
1300
1326
 
1301
1327
  ### entries
1302
1328
 
@@ -1306,13 +1332,13 @@ List entries of the branch.
1306
1332
 
1307
1333
  * `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1308
1334
 
1309
- Returns **ContentEntry** all matching entries in the branch
1335
+ Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
1310
1336
 
1311
1337
  ### asyncIterator
1312
1338
 
1313
1339
  List all entries of the branch.
1314
1340
 
1315
- Returns **asyncIterator\<ContentEntry>** all entries in the branch
1341
+ Returns **AsyncIterator<[ContentEntry](#contententry)>** all entries in the branch
1316
1342
 
1317
1343
  ### maybeEntry
1318
1344
 
@@ -1322,7 +1348,7 @@ Get exactly one matching entry by name or undefine if no such entry is found.
1322
1348
 
1323
1349
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1324
1350
 
1325
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**
1351
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1326
1352
 
1327
1353
  ### entry
1328
1354
 
@@ -1332,13 +1358,13 @@ Get exactly one matching entry by name (throws if entry is not found).
1332
1358
 
1333
1359
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1334
1360
 
1335
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**
1361
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1336
1362
 
1337
1363
  ### provider
1338
1364
 
1339
1365
  The provider we live in.
1340
1366
 
1341
- Returns **Provider**
1367
+ Returns **[BaseProvider](#baseprovider)**
1342
1368
 
1343
1369
  ### owner
1344
1370
 
@@ -1422,7 +1448,7 @@ Abstract repository collection.
1422
1448
 
1423
1449
  ### Parameters
1424
1450
 
1425
- * `provider` **Provider**
1451
+ * `provider` **[BaseProvider](#baseprovider)**
1426
1452
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1427
1453
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1428
1454
 
@@ -1433,7 +1459,7 @@ Abstract repository collection.
1433
1459
 
1434
1460
  ### Properties
1435
1461
 
1436
- * `provider` **Provider**
1462
+ * `provider` **[BaseProvider](#baseprovider)**
1437
1463
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1438
1464
 
1439
1465
  ### repositoryClass
@@ -1530,7 +1556,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1530
1556
 
1531
1557
  The owners provider.
1532
1558
 
1533
- Returns **Provider**
1559
+ Returns **[BaseProvider](#baseprovider)**
1534
1560
 
1535
1561
  ### identifier
1536
1562
 
@@ -1557,7 +1583,7 @@ Lookup entries form the head of the default branch.
1557
1583
 
1558
1584
  * `name`
1559
1585
 
1560
- Returns **Entry**
1586
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1561
1587
 
1562
1588
  ### entries
1563
1589
 
@@ -1567,7 +1593,7 @@ List entries of the default branch.
1567
1593
 
1568
1594
  * `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1569
1595
 
1570
- Returns **Entry** all matching entries in the branch
1596
+ Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
1571
1597
 
1572
1598
  ### maybeEntry
1573
1599
 
@@ -1577,7 +1603,7 @@ Get exactly one matching entry by name or undefined if no such entry is found.
1577
1603
 
1578
1604
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1579
1605
 
1580
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Entry>**
1606
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1581
1607
 
1582
1608
  ### urls
1583
1609
 
@@ -1639,10 +1665,6 @@ By default we are not a template.
1639
1665
 
1640
1666
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
1641
1667
 
1642
- ### update
1643
-
1644
- Updates repositroy attributes.
1645
-
1646
1668
  ### branch
1647
1669
 
1648
1670
  Lookup branch by name.
@@ -1665,7 +1687,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
1665
1687
 
1666
1688
  * `patterns`
1667
1689
 
1668
- Returns **Iterator<[Branch](#branch)>** of all branches
1690
+ Returns **AsyncIterator<[Branch](#branch)>** of all branches
1669
1691
 
1670
1692
  ### createBranch
1671
1693
 
@@ -1699,7 +1721,7 @@ Delete a [Branch](#branch).
1699
1721
 
1700
1722
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
1701
1723
 
1702
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**
1724
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
1703
1725
 
1704
1726
  ### tags
1705
1727
 
@@ -1707,7 +1729,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
1707
1729
 
1708
1730
  * `patterns` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**
1709
1731
 
1710
- Returns **Iterator<[Tag](#tag)>** of all tags
1732
+ Returns **AsyncIterator<[Tag](#tag)>** of all tags
1711
1733
 
1712
1734
  ### tag
1713
1735
 
@@ -1717,14 +1739,14 @@ Get a Tag.
1717
1739
 
1718
1740
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1719
1741
 
1720
- Returns **[Tag](#tag)**
1742
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>**
1721
1743
 
1722
1744
  ### delete
1723
1745
 
1724
1746
  Delete the repository from the [Provider](Provider).
1725
1747
  [Provider#deleteRepository](Provider#deleteRepository)
1726
1748
 
1727
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**
1749
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
1728
1750
 
1729
1751
  ### createPullRequest
1730
1752
 
@@ -1736,7 +1758,7 @@ Create a pull request (or deliver an already present for thefiven name).
1736
1758
  * `source` **[Branch](#branch)** branch
1737
1759
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1738
1760
 
1739
- Returns **[PullRequest](#pullrequest)**
1761
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
1740
1762
 
1741
1763
  ### addPullRequest
1742
1764
 
@@ -1754,7 +1776,7 @@ Returns **[PullRequest](#pullrequest)**
1754
1776
 
1755
1777
  Deliver all [PullRequest](#pullrequest)s.
1756
1778
 
1757
- Returns **Iterator<[PullRequest](#pullrequest)>** of all pull requests
1779
+ Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
1758
1780
 
1759
1781
  ### pullRequest
1760
1782
 
@@ -1774,7 +1796,7 @@ Delete a [PullRequest](#pullrequest).
1774
1796
 
1775
1797
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1776
1798
 
1777
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
1799
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
1778
1800
 
1779
1801
  ### addHook
1780
1802
 
@@ -1796,7 +1818,7 @@ Add a new Hook.
1796
1818
 
1797
1819
  List hooks.
1798
1820
 
1799
- Returns **[Hook](#hook)** all hooks of the repository
1821
+ Returns **AsyncIterator<[Hook](#hook)>** all hooks of the repository
1800
1822
 
1801
1823
  ### hook
1802
1824
 
@@ -1806,7 +1828,7 @@ Get a Hook.
1806
1828
 
1807
1829
  * `id` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))**
1808
1830
 
1809
- Returns **[Hook](#hook)** for the given id
1831
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Hook](#hook)>** for the given id
1810
1832
 
1811
1833
  ### type
1812
1834
 
@@ -1822,7 +1844,7 @@ Get sha of a ref.
1822
1844
 
1823
1845
  * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1824
1846
 
1825
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** sha of the ref
1847
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
1826
1848
 
1827
1849
  ### repositoryClass
1828
1850
 
@@ -1874,12 +1896,6 @@ URLs of the repository
1874
1896
 
1875
1897
  Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1876
1898
 
1877
- ## homePageURL
1878
-
1879
- The url of home page.
1880
-
1881
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1882
-
1883
1899
  ## issuesURL
1884
1900
 
1885
1901
  The url of issue tracking system.
@@ -1904,7 +1920,7 @@ Lookup a repository in the provider and all of its repository groups.
1904
1920
 
1905
1921
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1906
1922
 
1907
- Returns **[Repository](#repository)**
1923
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
1908
1924
 
1909
1925
  ### repositoryGroup
1910
1926
 
@@ -1914,7 +1930,7 @@ Get a single group.
1914
1930
 
1915
1931
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1916
1932
 
1917
- Returns **[RepositoryGroup](#repositorygroup)** deliver the one and only present group
1933
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** deliver the one and only present group
1918
1934
 
1919
1935
  ### repositoryGroups
1920
1936
 
@@ -1924,7 +1940,7 @@ List groups.
1924
1940
 
1925
1941
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
1926
1942
 
1927
- Returns **Iterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
1943
+ Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
1928
1944
 
1929
1945
  ## Tag
1930
1946
 
@@ -1962,7 +1978,7 @@ A URL auth component will be removed to.
1962
1978
 
1963
1979
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1964
1980
  * `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
1965
- * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** to be called with the found base name
1981
+ * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
1966
1982
 
1967
1983
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name without base
1968
1984
 
@@ -1972,9 +1988,9 @@ Loops over names and executes stripBaseName.
1972
1988
 
1973
1989
  ### Parameters
1974
1990
 
1975
- * `names` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1991
+ * `names` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**
1976
1992
  * `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
1977
- * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** to be called with the found base name
1993
+ * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
1978
1994
 
1979
1995
  Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** names without base
1980
1996
 
@@ -1989,6 +2005,8 @@ Find a new branch name for a given pattern.
1989
2005
  * `repository` **[Repository](#repository)**
1990
2006
  * `pattern` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1991
2007
 
2008
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
2009
+
1992
2010
  # install
1993
2011
 
1994
2012
  With [npm](http://npmjs.org) do: