repository-provider 26.0.2 → 26.1.2
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 +93 -72
- package/package.json +10 -7
- package/src/attribute.mjs +45 -18
- package/src/base-object.mjs +4 -0
- package/src/base-provider.mjs +53 -44
- package/src/branch.mjs +8 -4
- package/src/hook.mjs +1 -0
- package/src/multi-group-provider.mjs +6 -4
- package/src/named-object.mjs +1 -1
- package/src/pull-request.mjs +7 -3
- package/src/ref.mjs +12 -6
- package/src/repository-group.mjs +3 -2
- package/src/repository-owner.mjs +5 -4
- package/src/repository.mjs +20 -21
- package/src/single-group-provider.mjs +5 -3
- package/src/tag.mjs +3 -1
- package/src/util.mjs +6 -3
package/README.md
CHANGED
|
@@ -72,6 +72,7 @@ console.log(await readme.getString());
|
|
|
72
72
|
* [id](#id)
|
|
73
73
|
* [uuid](#uuid)
|
|
74
74
|
* [avatarURL](#avatarurl)
|
|
75
|
+
* [homePageURL](#homepageurl)
|
|
75
76
|
* [MessageDestination](#messagedestination)
|
|
76
77
|
* [Parameters](#parameters-9)
|
|
77
78
|
* [BaseProvider](#baseprovider)
|
|
@@ -94,7 +95,7 @@ console.log(await readme.getString());
|
|
|
94
95
|
* [Parameters](#parameters-16)
|
|
95
96
|
* [projects](#projects)
|
|
96
97
|
* [Parameters](#parameters-17)
|
|
97
|
-
* [
|
|
98
|
+
* [milestones](#milestones)
|
|
98
99
|
* [Parameters](#parameters-18)
|
|
99
100
|
* [repositories](#repositories)
|
|
100
101
|
* [Parameters](#parameters-19)
|
|
@@ -137,6 +138,7 @@ console.log(await readme.getString());
|
|
|
137
138
|
* [Parameters](#parameters-28)
|
|
138
139
|
* [Properties](#properties-5)
|
|
139
140
|
* [url](#url-1)
|
|
141
|
+
* [refType](#reftype)
|
|
140
142
|
* [isDefault](#isdefault)
|
|
141
143
|
* [delete](#delete)
|
|
142
144
|
* [commit](#commit-2)
|
|
@@ -211,6 +213,8 @@ console.log(await readme.getString());
|
|
|
211
213
|
* [locked](#locked)
|
|
212
214
|
* [merged](#merged)
|
|
213
215
|
* [draft](#draft)
|
|
216
|
+
* [ContentEntry](#contententry)
|
|
217
|
+
* [Properties](#properties-9)
|
|
214
218
|
* [Ref](#ref)
|
|
215
219
|
* [Parameters](#parameters-52)
|
|
216
220
|
* [equals](#equals-5)
|
|
@@ -231,7 +235,7 @@ console.log(await readme.getString());
|
|
|
231
235
|
* [fullCondensedName](#fullcondensedname)
|
|
232
236
|
* [identifier](#identifier-1)
|
|
233
237
|
* [issuesURL](#issuesurl)
|
|
234
|
-
* [homePageURL](#homepageurl)
|
|
238
|
+
* [homePageURL](#homepageurl-1)
|
|
235
239
|
* [isLocked](#islocked)
|
|
236
240
|
* [isArchived](#isarchived)
|
|
237
241
|
* [isDisabled](#isdisabled)
|
|
@@ -241,7 +245,7 @@ console.log(await readme.getString());
|
|
|
241
245
|
* [isProtected](#isprotected-1)
|
|
242
246
|
* [RepositoryGroup](#repositorygroup-1)
|
|
243
247
|
* [Parameters](#parameters-58)
|
|
244
|
-
* [Properties](#properties-
|
|
248
|
+
* [Properties](#properties-10)
|
|
245
249
|
* [repositoryClass](#repositoryclass-1)
|
|
246
250
|
* [branchClass](#branchclass-1)
|
|
247
251
|
* [contentClass](#contentclass)
|
|
@@ -254,7 +258,7 @@ console.log(await readme.getString());
|
|
|
254
258
|
* [Parameters](#parameters-59)
|
|
255
259
|
* [Repository](#repository-2)
|
|
256
260
|
* [Parameters](#parameters-60)
|
|
257
|
-
* [Properties](#properties-
|
|
261
|
+
* [Properties](#properties-11)
|
|
258
262
|
* [fullName](#fullname-2)
|
|
259
263
|
* [slug](#slug)
|
|
260
264
|
* [provider](#provider-3)
|
|
@@ -271,7 +275,7 @@ console.log(await readme.getString());
|
|
|
271
275
|
* [url](#url-4)
|
|
272
276
|
* [cloneURL](#cloneurl)
|
|
273
277
|
* [issuesURL](#issuesurl-1)
|
|
274
|
-
* [homePageURL](#homepageurl-
|
|
278
|
+
* [homePageURL](#homepageurl-2)
|
|
275
279
|
* [condensedName](#condensedname)
|
|
276
280
|
* [isArchived](#isarchived-1)
|
|
277
281
|
* [isLocked](#islocked-1)
|
|
@@ -321,7 +325,6 @@ console.log(await readme.getString());
|
|
|
321
325
|
* [attributes](#attributes-2)
|
|
322
326
|
* [defaultBranchName](#defaultbranchname)
|
|
323
327
|
* [urls](#urls-1)
|
|
324
|
-
* [homePageURL](#homepageurl-2)
|
|
325
328
|
* [issuesURL](#issuesurl-2)
|
|
326
329
|
* [Review](#review)
|
|
327
330
|
* [SingleGroupProvider](#singlegroupprovider)
|
|
@@ -333,6 +336,7 @@ console.log(await readme.getString());
|
|
|
333
336
|
* [Parameters](#parameters-82)
|
|
334
337
|
* [Tag](#tag-1)
|
|
335
338
|
* [Parameters](#parameters-83)
|
|
339
|
+
* [refType](#reftype-1)
|
|
336
340
|
* [isWritable](#iswritable-1)
|
|
337
341
|
* [asArray](#asarray)
|
|
338
342
|
* [Parameters](#parameters-84)
|
|
@@ -425,8 +429,7 @@ In other words only produce key value pairs if value is defined.
|
|
|
425
429
|
|
|
426
430
|
* `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
427
431
|
* `initial` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
|
|
428
|
-
* `attributes`
|
|
429
|
-
* `attibutes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to operator on
|
|
432
|
+
* `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to operator on (optional, default `object.constructor.attributes`)
|
|
430
433
|
|
|
431
434
|
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** initial + defined values
|
|
432
435
|
|
|
@@ -513,6 +516,12 @@ Avatar.
|
|
|
513
516
|
|
|
514
517
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
515
518
|
|
|
519
|
+
## homePageURL
|
|
520
|
+
|
|
521
|
+
The url of home page.
|
|
522
|
+
|
|
523
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
524
|
+
|
|
516
525
|
## MessageDestination
|
|
517
526
|
|
|
518
527
|
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
@@ -557,7 +566,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
|
|
|
557
566
|
|
|
558
567
|
### normalizeRepositoryName
|
|
559
568
|
|
|
560
|
-
Bring a repository name into its normal form by removing any clutter
|
|
569
|
+
Bring a repository name into its normal form by removing any clutter.
|
|
561
570
|
like .git suffix or #branch names.
|
|
562
571
|
|
|
563
572
|
#### Parameters
|
|
@@ -569,7 +578,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
569
578
|
|
|
570
579
|
### normalizeGroupName
|
|
571
580
|
|
|
572
|
-
Bring a group name into its normal form by removing any clutter
|
|
581
|
+
Bring a group name into its normal form by removing any clutter.
|
|
573
582
|
like .git suffix or #branch names.
|
|
574
583
|
|
|
575
584
|
#### Parameters
|
|
@@ -581,7 +590,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
581
590
|
|
|
582
591
|
### areRepositoryNamesCaseSensitive
|
|
583
592
|
|
|
584
|
-
Are
|
|
593
|
+
Are repository names case sensitive.
|
|
585
594
|
Overwrite and return false if you want to have case insensitive repository lookup
|
|
586
595
|
|
|
587
596
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
|
|
@@ -632,9 +641,9 @@ List projects.
|
|
|
632
641
|
|
|
633
642
|
* `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))**
|
|
634
643
|
|
|
635
|
-
Returns **
|
|
644
|
+
Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
|
|
636
645
|
|
|
637
|
-
###
|
|
646
|
+
### milestones
|
|
638
647
|
|
|
639
648
|
List milestones.
|
|
640
649
|
|
|
@@ -642,7 +651,7 @@ List milestones.
|
|
|
642
651
|
|
|
643
652
|
* `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))**
|
|
644
653
|
|
|
645
|
-
Returns **
|
|
654
|
+
Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
|
|
646
655
|
|
|
647
656
|
### repositories
|
|
648
657
|
|
|
@@ -652,7 +661,7 @@ List repositories.
|
|
|
652
661
|
|
|
653
662
|
* `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))**
|
|
654
663
|
|
|
655
|
-
Returns **
|
|
664
|
+
Returns **AsyncIterator<[Repository](#repository)>** all matching repos of the provider
|
|
656
665
|
|
|
657
666
|
### branches
|
|
658
667
|
|
|
@@ -662,7 +671,7 @@ List branches.
|
|
|
662
671
|
|
|
663
672
|
* `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))**
|
|
664
673
|
|
|
665
|
-
Returns **
|
|
674
|
+
Returns **AsyncIterator<[Branch](#branch)>** all matching branches of the provider
|
|
666
675
|
|
|
667
676
|
### tags
|
|
668
677
|
|
|
@@ -672,7 +681,7 @@ List tags.
|
|
|
672
681
|
|
|
673
682
|
* `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))**
|
|
674
683
|
|
|
675
|
-
Returns **
|
|
684
|
+
Returns **AsyncIterator<[Tag](#tag)>** all matching tags of the provider
|
|
676
685
|
|
|
677
686
|
### hooks
|
|
678
687
|
|
|
@@ -682,7 +691,7 @@ List hooks.
|
|
|
682
691
|
|
|
683
692
|
* `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))**
|
|
684
693
|
|
|
685
|
-
Returns **
|
|
694
|
+
Returns **AsyncIterator<[Hook](#hook)>** all matching hooks of the provider
|
|
686
695
|
|
|
687
696
|
### pullRequests
|
|
688
697
|
|
|
@@ -692,7 +701,7 @@ List pull requests.
|
|
|
692
701
|
|
|
693
702
|
* `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))**
|
|
694
703
|
|
|
695
|
-
Returns **
|
|
704
|
+
Returns **AsyncIterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
|
|
696
705
|
|
|
697
706
|
### repositoryGroupClass
|
|
698
707
|
|
|
@@ -712,7 +721,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
712
721
|
|
|
713
722
|
We are our own provider.
|
|
714
723
|
|
|
715
|
-
Returns **
|
|
724
|
+
Returns **[BaseProvider](#baseprovider)** this
|
|
716
725
|
|
|
717
726
|
### url
|
|
718
727
|
|
|
@@ -776,7 +785,7 @@ Creates a new provider for a given set of options.
|
|
|
776
785
|
* `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**
|
|
777
786
|
* `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
|
|
778
787
|
|
|
779
|
-
Returns **
|
|
788
|
+
Returns **[BaseProvider](#baseprovider)** newly created provider or undefined if options are not sufficient to construct a provider
|
|
780
789
|
|
|
781
790
|
## priority
|
|
782
791
|
|
|
@@ -798,7 +807,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
|
|
|
798
807
|
### Properties
|
|
799
808
|
|
|
800
809
|
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
801
|
-
* `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)
|
|
810
|
+
* `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>**
|
|
802
811
|
|
|
803
812
|
## Commit
|
|
804
813
|
|
|
@@ -846,6 +855,10 @@ Deliver repository and branch url combined.
|
|
|
846
855
|
|
|
847
856
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repoUrl#branch'
|
|
848
857
|
|
|
858
|
+
### refType
|
|
859
|
+
|
|
860
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
|
|
861
|
+
|
|
849
862
|
### isDefault
|
|
850
863
|
|
|
851
864
|
Are we the default branch.
|
|
@@ -858,7 +871,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
858
871
|
|
|
859
872
|
Delete the branch from the [Repository](#repository).
|
|
860
873
|
|
|
861
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
874
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
|
|
862
875
|
|
|
863
876
|
### commit
|
|
864
877
|
|
|
@@ -867,10 +880,10 @@ Commit entries.
|
|
|
867
880
|
#### Parameters
|
|
868
881
|
|
|
869
882
|
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
|
|
870
|
-
* `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)
|
|
883
|
+
* `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** content to be commited
|
|
871
884
|
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
872
885
|
|
|
873
|
-
Returns **[CommitResult](#commitresult)
|
|
886
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>**
|
|
874
887
|
|
|
875
888
|
### commitIntoPullRequest
|
|
876
889
|
|
|
@@ -886,7 +899,7 @@ Add commits into a pull request.
|
|
|
886
899
|
* `options.skipWithoutCommits` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a PR if no commits are given
|
|
887
900
|
* `options.bodyFromCommitMessages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** generate body from commit messages
|
|
888
901
|
|
|
889
|
-
Returns **[PullRequest](#pullrequest)
|
|
902
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
|
|
890
903
|
|
|
891
904
|
### removeEntries
|
|
892
905
|
|
|
@@ -894,7 +907,7 @@ Remove entries form the branch.
|
|
|
894
907
|
|
|
895
908
|
#### Parameters
|
|
896
909
|
|
|
897
|
-
* `entries` **
|
|
910
|
+
* `entries` **AsyncIterator<[ContentEntry](#contententry)>**
|
|
898
911
|
|
|
899
912
|
### entryClass
|
|
900
913
|
|
|
@@ -1002,7 +1015,7 @@ Lookup a repository in the provider and all of its repository groups.
|
|
|
1002
1015
|
|
|
1003
1016
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
|
|
1004
1017
|
|
|
1005
|
-
Returns **[Repository](#repository)
|
|
1018
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
|
|
1006
1019
|
|
|
1007
1020
|
### repositoryGroup
|
|
1008
1021
|
|
|
@@ -1012,7 +1025,7 @@ Lookup a repository group.
|
|
|
1012
1025
|
|
|
1013
1026
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1014
1027
|
|
|
1015
|
-
Returns **[RepositoryGroup](#repositorygroup)
|
|
1028
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**
|
|
1016
1029
|
|
|
1017
1030
|
### repositoryGroups
|
|
1018
1031
|
|
|
@@ -1022,7 +1035,7 @@ List groups.
|
|
|
1022
1035
|
|
|
1023
1036
|
* `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))**
|
|
1024
1037
|
|
|
1025
|
-
Returns **
|
|
1038
|
+
Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
|
|
1026
1039
|
|
|
1027
1040
|
### createRepositoryGroup
|
|
1028
1041
|
|
|
@@ -1034,7 +1047,7 @@ If there is already a group for the given name it will be returend instead
|
|
|
1034
1047
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1035
1048
|
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
1036
1049
|
|
|
1037
|
-
Returns **[RepositoryGroup](#repositorygroup)
|
|
1050
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**
|
|
1038
1051
|
|
|
1039
1052
|
### addRepositoryGroup
|
|
1040
1053
|
|
|
@@ -1081,7 +1094,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
1081
1094
|
|
|
1082
1095
|
### update
|
|
1083
1096
|
|
|
1084
|
-
|
|
1097
|
+
Save object attributes in the backing store.
|
|
1085
1098
|
|
|
1086
1099
|
### toJSON
|
|
1087
1100
|
|
|
@@ -1145,7 +1158,7 @@ Returns **[Repository](#repository)** destination repository
|
|
|
1145
1158
|
|
|
1146
1159
|
### provider
|
|
1147
1160
|
|
|
1148
|
-
Returns **
|
|
1161
|
+
Returns **[BaseProvider](#baseprovider)**
|
|
1149
1162
|
|
|
1150
1163
|
### equals
|
|
1151
1164
|
|
|
@@ -1179,7 +1192,7 @@ Decline the pull request.
|
|
|
1179
1192
|
|
|
1180
1193
|
### reviews
|
|
1181
1194
|
|
|
1182
|
-
Returns **
|
|
1195
|
+
Returns **AsyncIterator<[Review](#review)>**
|
|
1183
1196
|
|
|
1184
1197
|
### identifier
|
|
1185
1198
|
|
|
@@ -1219,7 +1232,7 @@ result will be filtered by source branch, destination branch and states
|
|
|
1219
1232
|
* `filter.destination` **[Branch](#branch)?**
|
|
1220
1233
|
* `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)>?**
|
|
1221
1234
|
|
|
1222
|
-
Returns **
|
|
1235
|
+
Returns **AsyncIterator<[PullRequest](#pullrequest)>**
|
|
1223
1236
|
|
|
1224
1237
|
### open
|
|
1225
1238
|
|
|
@@ -1271,6 +1284,14 @@ Draft state of the pull request.
|
|
|
1271
1284
|
|
|
1272
1285
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
|
|
1273
1286
|
|
|
1287
|
+
## ContentEntry
|
|
1288
|
+
|
|
1289
|
+
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
1290
|
+
|
|
1291
|
+
### Properties
|
|
1292
|
+
|
|
1293
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1294
|
+
|
|
1274
1295
|
## Ref
|
|
1275
1296
|
|
|
1276
1297
|
**Extends NamedObject**
|
|
@@ -1289,13 +1310,13 @@ Check for equality.
|
|
|
1289
1310
|
|
|
1290
1311
|
#### Parameters
|
|
1291
1312
|
|
|
1292
|
-
* `other` **[
|
|
1313
|
+
* `other` **[Ref](#ref)**
|
|
1293
1314
|
|
|
1294
1315
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name and repository are equal
|
|
1295
1316
|
|
|
1296
1317
|
### ref
|
|
1297
1318
|
|
|
1298
|
-
ref name
|
|
1319
|
+
ref name.
|
|
1299
1320
|
|
|
1300
1321
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** git ref of the Ref
|
|
1301
1322
|
|
|
@@ -1307,7 +1328,7 @@ Get sha of a ref.
|
|
|
1307
1328
|
|
|
1308
1329
|
* `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `this.ref`)
|
|
1309
1330
|
|
|
1310
|
-
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
1331
|
+
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
|
|
1311
1332
|
|
|
1312
1333
|
### entries
|
|
1313
1334
|
|
|
@@ -1317,13 +1338,13 @@ List entries of the branch.
|
|
|
1317
1338
|
|
|
1318
1339
|
* `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)>**
|
|
1319
1340
|
|
|
1320
|
-
Returns **ContentEntry
|
|
1341
|
+
Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
|
|
1321
1342
|
|
|
1322
1343
|
### asyncIterator
|
|
1323
1344
|
|
|
1324
1345
|
List all entries of the branch.
|
|
1325
1346
|
|
|
1326
|
-
Returns **
|
|
1347
|
+
Returns **AsyncIterator<[ContentEntry](#contententry)>** all entries in the branch
|
|
1327
1348
|
|
|
1328
1349
|
### maybeEntry
|
|
1329
1350
|
|
|
@@ -1333,7 +1354,7 @@ Get exactly one matching entry by name or undefine if no such entry is found.
|
|
|
1333
1354
|
|
|
1334
1355
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1335
1356
|
|
|
1336
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
1357
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
|
|
1337
1358
|
|
|
1338
1359
|
### entry
|
|
1339
1360
|
|
|
@@ -1343,13 +1364,13 @@ Get exactly one matching entry by name (throws if entry is not found).
|
|
|
1343
1364
|
|
|
1344
1365
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1345
1366
|
|
|
1346
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
1367
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
|
|
1347
1368
|
|
|
1348
1369
|
### provider
|
|
1349
1370
|
|
|
1350
1371
|
The provider we live in.
|
|
1351
1372
|
|
|
1352
|
-
Returns **
|
|
1373
|
+
Returns **[BaseProvider](#baseprovider)**
|
|
1353
1374
|
|
|
1354
1375
|
### owner
|
|
1355
1376
|
|
|
@@ -1433,7 +1454,7 @@ Abstract repository collection.
|
|
|
1433
1454
|
|
|
1434
1455
|
### Parameters
|
|
1435
1456
|
|
|
1436
|
-
* `provider` **
|
|
1457
|
+
* `provider` **[BaseProvider](#baseprovider)**
|
|
1437
1458
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1438
1459
|
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
1439
1460
|
|
|
@@ -1444,7 +1465,7 @@ Abstract repository collection.
|
|
|
1444
1465
|
|
|
1445
1466
|
### Properties
|
|
1446
1467
|
|
|
1447
|
-
* `provider` **
|
|
1468
|
+
* `provider` **[BaseProvider](#baseprovider)**
|
|
1448
1469
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1449
1470
|
|
|
1450
1471
|
### repositoryClass
|
|
@@ -1541,7 +1562,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
1541
1562
|
|
|
1542
1563
|
The owners provider.
|
|
1543
1564
|
|
|
1544
|
-
Returns **
|
|
1565
|
+
Returns **[BaseProvider](#baseprovider)**
|
|
1545
1566
|
|
|
1546
1567
|
### identifier
|
|
1547
1568
|
|
|
@@ -1568,7 +1589,7 @@ Lookup entries form the head of the default branch.
|
|
|
1568
1589
|
|
|
1569
1590
|
* `name`
|
|
1570
1591
|
|
|
1571
|
-
Returns **
|
|
1592
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
|
|
1572
1593
|
|
|
1573
1594
|
### entries
|
|
1574
1595
|
|
|
@@ -1578,7 +1599,7 @@ List entries of the default branch.
|
|
|
1578
1599
|
|
|
1579
1600
|
* `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)>**
|
|
1580
1601
|
|
|
1581
|
-
Returns **
|
|
1602
|
+
Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
|
|
1582
1603
|
|
|
1583
1604
|
### maybeEntry
|
|
1584
1605
|
|
|
@@ -1588,7 +1609,7 @@ Get exactly one matching entry by name or undefined if no such entry is found.
|
|
|
1588
1609
|
|
|
1589
1610
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1590
1611
|
|
|
1591
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
1612
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
|
|
1592
1613
|
|
|
1593
1614
|
### urls
|
|
1594
1615
|
|
|
@@ -1672,7 +1693,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
1672
1693
|
|
|
1673
1694
|
* `patterns`
|
|
1674
1695
|
|
|
1675
|
-
Returns **
|
|
1696
|
+
Returns **AsyncIterator<[Branch](#branch)>** of all branches
|
|
1676
1697
|
|
|
1677
1698
|
### createBranch
|
|
1678
1699
|
|
|
@@ -1706,7 +1727,7 @@ Delete a [Branch](#branch).
|
|
|
1706
1727
|
|
|
1707
1728
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
|
|
1708
1729
|
|
|
1709
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
1730
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
|
|
1710
1731
|
|
|
1711
1732
|
### tags
|
|
1712
1733
|
|
|
@@ -1714,7 +1735,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
1714
1735
|
|
|
1715
1736
|
* `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)>)**
|
|
1716
1737
|
|
|
1717
|
-
Returns **
|
|
1738
|
+
Returns **AsyncIterator<[Tag](#tag)>** of all tags
|
|
1718
1739
|
|
|
1719
1740
|
### tag
|
|
1720
1741
|
|
|
@@ -1724,14 +1745,14 @@ Get a Tag.
|
|
|
1724
1745
|
|
|
1725
1746
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1726
1747
|
|
|
1727
|
-
Returns **[Tag](#tag)
|
|
1748
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>**
|
|
1728
1749
|
|
|
1729
1750
|
### delete
|
|
1730
1751
|
|
|
1731
1752
|
Delete the repository from the [Provider](Provider).
|
|
1732
1753
|
[Provider#deleteRepository](Provider#deleteRepository)
|
|
1733
1754
|
|
|
1734
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
1755
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
|
|
1735
1756
|
|
|
1736
1757
|
### createPullRequest
|
|
1737
1758
|
|
|
@@ -1743,7 +1764,7 @@ Create a pull request (or deliver an already present for thefiven name).
|
|
|
1743
1764
|
* `source` **[Branch](#branch)** branch
|
|
1744
1765
|
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
1745
1766
|
|
|
1746
|
-
Returns **[PullRequest](#pullrequest)
|
|
1767
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
|
|
1747
1768
|
|
|
1748
1769
|
### addPullRequest
|
|
1749
1770
|
|
|
@@ -1761,7 +1782,7 @@ Returns **[PullRequest](#pullrequest)**
|
|
|
1761
1782
|
|
|
1762
1783
|
Deliver all [PullRequest](#pullrequest)s.
|
|
1763
1784
|
|
|
1764
|
-
Returns **
|
|
1785
|
+
Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
|
|
1765
1786
|
|
|
1766
1787
|
### pullRequest
|
|
1767
1788
|
|
|
@@ -1781,7 +1802,7 @@ Delete a [PullRequest](#pullrequest).
|
|
|
1781
1802
|
|
|
1782
1803
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1783
1804
|
|
|
1784
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
1805
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
|
|
1785
1806
|
|
|
1786
1807
|
### addHook
|
|
1787
1808
|
|
|
@@ -1803,7 +1824,7 @@ Add a new Hook.
|
|
|
1803
1824
|
|
|
1804
1825
|
List hooks.
|
|
1805
1826
|
|
|
1806
|
-
Returns **[Hook](#hook)
|
|
1827
|
+
Returns **AsyncIterator<[Hook](#hook)>** all hooks of the repository
|
|
1807
1828
|
|
|
1808
1829
|
### hook
|
|
1809
1830
|
|
|
@@ -1813,7 +1834,7 @@ Get a Hook.
|
|
|
1813
1834
|
|
|
1814
1835
|
* `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))**
|
|
1815
1836
|
|
|
1816
|
-
Returns **[Hook](#hook)
|
|
1837
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Hook](#hook)>** for the given id
|
|
1817
1838
|
|
|
1818
1839
|
### type
|
|
1819
1840
|
|
|
@@ -1829,7 +1850,7 @@ Get sha of a ref.
|
|
|
1829
1850
|
|
|
1830
1851
|
* `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1831
1852
|
|
|
1832
|
-
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
1853
|
+
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
|
|
1833
1854
|
|
|
1834
1855
|
### repositoryClass
|
|
1835
1856
|
|
|
@@ -1881,12 +1902,6 @@ URLs of the repository
|
|
|
1881
1902
|
|
|
1882
1903
|
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)>**
|
|
1883
1904
|
|
|
1884
|
-
## homePageURL
|
|
1885
|
-
|
|
1886
|
-
The url of home page.
|
|
1887
|
-
|
|
1888
|
-
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1889
|
-
|
|
1890
1905
|
## issuesURL
|
|
1891
1906
|
|
|
1892
1907
|
The url of issue tracking system.
|
|
@@ -1911,7 +1926,7 @@ Lookup a repository in the provider and all of its repository groups.
|
|
|
1911
1926
|
|
|
1912
1927
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
|
|
1913
1928
|
|
|
1914
|
-
Returns **[Repository](#repository)
|
|
1929
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
|
|
1915
1930
|
|
|
1916
1931
|
### repositoryGroup
|
|
1917
1932
|
|
|
@@ -1921,7 +1936,7 @@ Get a single group.
|
|
|
1921
1936
|
|
|
1922
1937
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1923
1938
|
|
|
1924
|
-
Returns **[RepositoryGroup](#repositorygroup)
|
|
1939
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** deliver the one and only present group
|
|
1925
1940
|
|
|
1926
1941
|
### repositoryGroups
|
|
1927
1942
|
|
|
@@ -1931,7 +1946,7 @@ List groups.
|
|
|
1931
1946
|
|
|
1932
1947
|
* `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))**
|
|
1933
1948
|
|
|
1934
|
-
Returns **
|
|
1949
|
+
Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
|
|
1935
1950
|
|
|
1936
1951
|
## Tag
|
|
1937
1952
|
|
|
@@ -1945,6 +1960,10 @@ Tag refs
|
|
|
1945
1960
|
* `name`
|
|
1946
1961
|
* `options`
|
|
1947
1962
|
|
|
1963
|
+
### refType
|
|
1964
|
+
|
|
1965
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
|
|
1966
|
+
|
|
1948
1967
|
### isWritable
|
|
1949
1968
|
|
|
1950
1969
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
|
|
@@ -1969,7 +1988,7 @@ A URL auth component will be removed to.
|
|
|
1969
1988
|
|
|
1970
1989
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1971
1990
|
* `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
|
|
1972
|
-
* `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
|
|
1991
|
+
* `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
|
|
1973
1992
|
|
|
1974
1993
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name without base
|
|
1975
1994
|
|
|
@@ -1979,9 +1998,9 @@ Loops over names and executes stripBaseName.
|
|
|
1979
1998
|
|
|
1980
1999
|
### Parameters
|
|
1981
2000
|
|
|
1982
|
-
* `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)
|
|
2001
|
+
* `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)>)**
|
|
1983
2002
|
* `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
|
|
1984
|
-
* `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
|
|
2003
|
+
* `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
|
|
1985
2004
|
|
|
1986
2005
|
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
|
|
1987
2006
|
|
|
@@ -1996,6 +2015,8 @@ Find a new branch name for a given pattern.
|
|
|
1996
2015
|
* `repository` **[Repository](#repository)**
|
|
1997
2016
|
* `pattern` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1998
2017
|
|
|
2018
|
+
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)>**
|
|
2019
|
+
|
|
1999
2020
|
# install
|
|
2000
2021
|
|
|
2001
2022
|
With [npm](http://npmjs.org) do:
|