repository-provider 32.7.13 → 32.7.14
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 +115 -87
- package/package.json +3 -3
- package/src/base-object.mjs +1 -1
- package/src/base-provider.mjs +29 -25
- package/src/branch.mjs +1 -1
- package/src/ref.mjs +1 -1
- package/src/repository-owner.mjs +6 -6
- package/src/repository.mjs +5 -0
- package/src/single-group-provider.mjs +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ see list of avaliable implementations below
|
|
|
22
22
|
```es6
|
|
23
23
|
import { Provider } from 'repository-provider';
|
|
24
24
|
|
|
25
|
-
const provider = new Provider({
|
|
25
|
+
const provider = new Provider({ /* access options as hosts and credentials */ });
|
|
26
26
|
|
|
27
27
|
const branch = await provider.branch('myuser/myrepo#myBranch');
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ for await (const entry of branch.entries('**/*.md')) {
|
|
|
32
32
|
|
|
33
33
|
const readme = await branch.entry('README.md');
|
|
34
34
|
|
|
35
|
-
console.log(await readme.
|
|
35
|
+
console.log(await readme.string);
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
# Derived Providers
|
|
@@ -324,29 +324,35 @@ console.log(await readme.getString());
|
|
|
324
324
|
* [hooks](#hooks-1)
|
|
325
325
|
* [hook](#hook-1)
|
|
326
326
|
* [Parameters](#parameters-78)
|
|
327
|
+
* [milestone](#milestone-1)
|
|
328
|
+
* [Parameters](#parameters-79)
|
|
329
|
+
* [project](#project-1)
|
|
330
|
+
* [Parameters](#parameters-80)
|
|
331
|
+
* [application](#application-1)
|
|
332
|
+
* [Parameters](#parameters-81)
|
|
327
333
|
* [type](#type-2)
|
|
328
334
|
* [refId](#refid-1)
|
|
329
|
-
* [Parameters](#parameters-
|
|
335
|
+
* [Parameters](#parameters-82)
|
|
330
336
|
* [attributes](#attributes-2)
|
|
331
337
|
* [defaultBranchName](#defaultbranchname)
|
|
332
338
|
* [Review](#review)
|
|
333
339
|
* [SingleGroupProvider](#singlegroupprovider)
|
|
334
340
|
* [repository](#repository-4)
|
|
335
|
-
* [Parameters](#parameters-
|
|
341
|
+
* [Parameters](#parameters-83)
|
|
336
342
|
* [repositoryGroup](#repositorygroup-2)
|
|
337
|
-
* [Parameters](#parameters-
|
|
343
|
+
* [Parameters](#parameters-84)
|
|
338
344
|
* [repositoryGroups](#repositorygroups-1)
|
|
339
|
-
* [Parameters](#parameters-
|
|
345
|
+
* [Parameters](#parameters-85)
|
|
340
346
|
* [Tag](#tag-1)
|
|
341
347
|
* [refType](#reftype-1)
|
|
342
348
|
* [asArray](#asarray)
|
|
343
|
-
* [Parameters](#parameters-
|
|
349
|
+
* [Parameters](#parameters-86)
|
|
344
350
|
* [stripBaseName](#stripbasename)
|
|
345
|
-
* [Parameters](#parameters-
|
|
351
|
+
* [Parameters](#parameters-87)
|
|
346
352
|
* [stripBaseNames](#stripbasenames)
|
|
347
|
-
* [Parameters](#parameters-
|
|
353
|
+
* [Parameters](#parameters-88)
|
|
348
354
|
* [generateBranchName](#generatebranchname)
|
|
349
|
-
* [Parameters](#parameters-
|
|
355
|
+
* [Parameters](#parameters-89)
|
|
350
356
|
|
|
351
357
|
## Application
|
|
352
358
|
|
|
@@ -388,7 +394,7 @@ Get default values.
|
|
|
388
394
|
### Parameters
|
|
389
395
|
|
|
390
396
|
* `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
391
|
-
* `object`
|
|
397
|
+
* `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
392
398
|
|
|
393
399
|
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** filled with default values
|
|
394
400
|
|
|
@@ -416,7 +422,7 @@ mapAttributes({a:1},{a:"a'"}) // {"a'": 1}
|
|
|
416
422
|
|
|
417
423
|
### Parameters
|
|
418
424
|
|
|
419
|
-
* `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
425
|
+
* `object` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
420
426
|
* `mapping` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
421
427
|
|
|
422
428
|
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** keys renamed after mapping
|
|
@@ -429,7 +435,7 @@ Filters out null, undefined and empty strings
|
|
|
429
435
|
### Parameters
|
|
430
436
|
|
|
431
437
|
* `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
432
|
-
* `mapping` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
438
|
+
* `mapping` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
433
439
|
|
|
434
440
|
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** keys renamed after mapping
|
|
435
441
|
|
|
@@ -510,10 +516,12 @@ this defines the order
|
|
|
510
516
|
|
|
511
517
|
## BaseObject
|
|
512
518
|
|
|
519
|
+
Creates an instance of BaseObject.
|
|
520
|
+
|
|
513
521
|
### Parameters
|
|
514
522
|
|
|
515
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
516
|
-
* `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
523
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
524
|
+
* `additionalProperties` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
517
525
|
|
|
518
526
|
### updateAttributes
|
|
519
527
|
|
|
@@ -521,7 +529,7 @@ Takes values from options.
|
|
|
521
529
|
|
|
522
530
|
#### Parameters
|
|
523
531
|
|
|
524
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
532
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
525
533
|
* `additionalProperties`  
|
|
526
534
|
|
|
527
535
|
### update
|
|
@@ -562,7 +570,7 @@ Check for equality
|
|
|
562
570
|
|
|
563
571
|
#### Parameters
|
|
564
572
|
|
|
565
|
-
* `other` **[BaseObject](#baseobject)** 
|
|
573
|
+
* `other` **([BaseObject](#baseobject) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
566
574
|
|
|
567
575
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other is present
|
|
568
576
|
|
|
@@ -619,7 +627,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
|
|
|
619
627
|
|
|
620
628
|
#### Parameters
|
|
621
629
|
|
|
622
|
-
* `other`
|
|
630
|
+
* `other` **any** 
|
|
623
631
|
|
|
624
632
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other provider is the same as the receiver
|
|
625
633
|
|
|
@@ -633,6 +641,7 @@ For github something like:
|
|
|
633
641
|
* git+ssh://github.com
|
|
634
642
|
* <https://github.com>
|
|
635
643
|
* git+<https://github.com>
|
|
644
|
+
By default we provide provider name with ':'.
|
|
636
645
|
|
|
637
646
|
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)>** common base urls of all repositories
|
|
638
647
|
|
|
@@ -642,14 +651,14 @@ Does the provider support the base name.
|
|
|
642
651
|
|
|
643
652
|
#### Parameters
|
|
644
653
|
|
|
645
|
-
* `base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** to be checked
|
|
654
|
+
* `base` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** to be checked
|
|
646
655
|
|
|
647
656
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if base is supported or base is undefined
|
|
648
657
|
|
|
649
658
|
### normalizeRepositoryName
|
|
650
659
|
|
|
651
660
|
Bring a repository name into its normal form by removing any clutter.
|
|
652
|
-
|
|
661
|
+
Like .git suffix or #branch names.
|
|
653
662
|
|
|
654
663
|
#### Parameters
|
|
655
664
|
|
|
@@ -661,7 +670,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
661
670
|
### normalizeGroupName
|
|
662
671
|
|
|
663
672
|
Bring a group name into its normal form by removing any clutter.
|
|
664
|
-
|
|
673
|
+
Like .git suffix or #branch names.
|
|
665
674
|
|
|
666
675
|
#### Parameters
|
|
667
676
|
|
|
@@ -673,14 +682,14 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
673
682
|
### areRepositoryNamesCaseSensitive
|
|
674
683
|
|
|
675
684
|
Are repository names case sensitive.
|
|
676
|
-
Overwrite and return false if you want to have case insensitive repository lookup
|
|
685
|
+
Overwrite and return false if you want to have case insensitive repository lookup.
|
|
677
686
|
|
|
678
687
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
|
|
679
688
|
|
|
680
689
|
### areGroupNamesCaseSensitive
|
|
681
690
|
|
|
682
691
|
Are repositroy group names case sensitive.
|
|
683
|
-
Overwrite and return false if you want to have case insensitive group lookup
|
|
692
|
+
Overwrite and return false if you want to have case insensitive group lookup.
|
|
684
693
|
|
|
685
694
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
|
|
686
695
|
|
|
@@ -691,7 +700,7 @@ base, group, repository and branch.
|
|
|
691
700
|
|
|
692
701
|
#### Parameters
|
|
693
702
|
|
|
694
|
-
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
703
|
+
* `name` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
695
704
|
* `focus` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** where lies the focus if only one path component is given (optional, default `"repository"`)
|
|
696
705
|
|
|
697
706
|
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** with separated attributes
|
|
@@ -703,7 +712,7 @@ Create a repository.
|
|
|
703
712
|
#### Parameters
|
|
704
713
|
|
|
705
714
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of group and repository
|
|
706
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
715
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
707
716
|
|
|
708
717
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>** 
|
|
709
718
|
|
|
@@ -714,7 +723,7 @@ List provider objects of a given type.
|
|
|
714
723
|
#### Parameters
|
|
715
724
|
|
|
716
725
|
* `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
|
|
717
|
-
* `patterns` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [
|
|
726
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** group / repository filter
|
|
718
727
|
|
|
719
728
|
### projects
|
|
720
729
|
|
|
@@ -722,7 +731,7 @@ List projects.
|
|
|
722
731
|
|
|
723
732
|
#### Parameters
|
|
724
733
|
|
|
725
|
-
* `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))** 
|
|
734
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
726
735
|
|
|
727
736
|
Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
|
|
728
737
|
|
|
@@ -732,7 +741,7 @@ List milestones.
|
|
|
732
741
|
|
|
733
742
|
#### Parameters
|
|
734
743
|
|
|
735
|
-
* `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))** 
|
|
744
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
736
745
|
|
|
737
746
|
Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
|
|
738
747
|
|
|
@@ -742,7 +751,7 @@ List repositories.
|
|
|
742
751
|
|
|
743
752
|
#### Parameters
|
|
744
753
|
|
|
745
|
-
* `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))** 
|
|
754
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
746
755
|
|
|
747
756
|
Returns **AsyncIterator<[Repository](#repository)>** all matching repos of the provider
|
|
748
757
|
|
|
@@ -752,7 +761,7 @@ List branches.
|
|
|
752
761
|
|
|
753
762
|
#### Parameters
|
|
754
763
|
|
|
755
|
-
* `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))** 
|
|
764
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
756
765
|
|
|
757
766
|
Returns **AsyncIterator<[Branch](#branch)>** all matching branches of the provider
|
|
758
767
|
|
|
@@ -762,7 +771,7 @@ List tags.
|
|
|
762
771
|
|
|
763
772
|
#### Parameters
|
|
764
773
|
|
|
765
|
-
* `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))** 
|
|
774
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
766
775
|
|
|
767
776
|
Returns **AsyncIterator<[Tag](#tag)>** all matching tags of the provider
|
|
768
777
|
|
|
@@ -772,7 +781,7 @@ List hooks.
|
|
|
772
781
|
|
|
773
782
|
#### Parameters
|
|
774
783
|
|
|
775
|
-
* `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))** 
|
|
784
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
776
785
|
|
|
777
786
|
Returns **AsyncIterator<[Hook](#hook)>** all matching hooks of the provider
|
|
778
787
|
|
|
@@ -782,7 +791,7 @@ List pull requests.
|
|
|
782
791
|
|
|
783
792
|
#### Parameters
|
|
784
793
|
|
|
785
|
-
* `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))** 
|
|
794
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
786
795
|
|
|
787
796
|
Returns **AsyncIterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
|
|
788
797
|
|
|
@@ -805,48 +814,37 @@ return {object}
|
|
|
805
814
|
|
|
806
815
|
### repositoryGroupClass
|
|
807
816
|
|
|
808
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** repository group class used by the Provider
|
|
809
|
-
|
|
810
817
|
### hookClass
|
|
811
818
|
|
|
812
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** hook class used by the Provider
|
|
813
|
-
|
|
814
819
|
### repositoryClass
|
|
815
820
|
|
|
816
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** repository class used by the Provider
|
|
817
|
-
|
|
818
821
|
### branchClass
|
|
819
822
|
|
|
820
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** branch class used by the Provider
|
|
821
|
-
|
|
822
823
|
### tagClass
|
|
823
824
|
|
|
824
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** branch class used by the Provider
|
|
825
|
-
|
|
826
825
|
### entryClass
|
|
827
826
|
|
|
828
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** entry class used by the Provider
|
|
829
|
-
|
|
830
827
|
### pullRequestClass
|
|
831
828
|
|
|
832
|
-
Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** pull request class used by the Provider
|
|
833
|
-
|
|
834
829
|
### instanceIdentifier
|
|
835
830
|
|
|
831
|
+
Prefix used to form environment variables.
|
|
832
|
+
'GITHUB\_' -> 'GITHUB\_TOKEN'
|
|
833
|
+
|
|
836
834
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** identifier for environment options
|
|
837
835
|
|
|
838
836
|
### optionsFromEnvironment
|
|
839
837
|
|
|
840
|
-
Extract options suitable for the constructor
|
|
841
|
-
|
|
838
|
+
Extract options suitable for the constructor.
|
|
839
|
+
Form the given set of environment variables.
|
|
842
840
|
Object with the detected key value pairs is delivered.
|
|
843
841
|
|
|
844
842
|
#### Parameters
|
|
845
843
|
|
|
846
|
-
* `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as from process.env
|
|
844
|
+
* `env` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** as from process.env
|
|
847
845
|
* `instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** part of variable name. (optional, default `this.instanceIdentifier`)
|
|
848
846
|
|
|
849
|
-
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** undefined if no suitable environment variables have been found
|
|
847
|
+
Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** undefined if no suitable environment variables have been found
|
|
850
848
|
|
|
851
849
|
### areOptionsSufficcient
|
|
852
850
|
|
|
@@ -869,7 +867,7 @@ Creates a new provider for a given set of options.
|
|
|
869
867
|
* `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
|
|
870
868
|
* `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
|
|
871
869
|
|
|
872
|
-
Returns **[BaseProvider](#baseprovider)** newly created provider or undefined if options are not sufficient to construct a provider
|
|
870
|
+
Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** newly created provider or undefined if options are not sufficient to construct a provider
|
|
873
871
|
|
|
874
872
|
## name
|
|
875
873
|
|
|
@@ -983,7 +981,7 @@ Simply calls Repository.createBranch() with the receiver as source branch
|
|
|
983
981
|
#### Parameters
|
|
984
982
|
|
|
985
983
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the new branch
|
|
986
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
984
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** passed through
|
|
987
985
|
|
|
988
986
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** newly created branch (or already present old one with the same name)
|
|
989
987
|
|
|
@@ -1037,7 +1035,7 @@ Lookup a repository in the provider and all of its repository groups.
|
|
|
1037
1035
|
|
|
1038
1036
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
|
|
1039
1037
|
|
|
1040
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>** 
|
|
1038
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Repository](#repository) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1041
1039
|
|
|
1042
1040
|
### branch
|
|
1043
1041
|
|
|
@@ -1047,7 +1045,7 @@ Lookup a branch.
|
|
|
1047
1045
|
|
|
1048
1046
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
|
|
1049
1047
|
|
|
1050
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** 
|
|
1048
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Branch](#branch) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1051
1049
|
|
|
1052
1050
|
### repositoryGroup
|
|
1053
1051
|
|
|
@@ -1057,7 +1055,7 @@ Lookup a repository group.
|
|
|
1057
1055
|
|
|
1058
1056
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1059
1057
|
|
|
1060
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** 
|
|
1058
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([RepositoryGroup](#repositorygroup) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1061
1059
|
|
|
1062
1060
|
### repositoryGroups
|
|
1063
1061
|
|
|
@@ -1077,7 +1075,7 @@ If there is already a group for the given name it will be returend instead
|
|
|
1077
1075
|
#### Parameters
|
|
1078
1076
|
|
|
1079
1077
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1080
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1078
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1081
1079
|
|
|
1082
1080
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** 
|
|
1083
1081
|
|
|
@@ -1088,7 +1086,7 @@ Add a new repository group (not provider specific actions are executed).
|
|
|
1088
1086
|
#### Parameters
|
|
1089
1087
|
|
|
1090
1088
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1091
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1089
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1092
1090
|
|
|
1093
1091
|
Returns **[RepositoryGroup](#repositorygroup)** 
|
|
1094
1092
|
|
|
@@ -1101,8 +1099,8 @@ Object with a name.
|
|
|
1101
1099
|
### Parameters
|
|
1102
1100
|
|
|
1103
1101
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1104
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1105
|
-
* `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1102
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1103
|
+
* `additionalProperties` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1106
1104
|
|
|
1107
1105
|
### Properties
|
|
1108
1106
|
|
|
@@ -1449,7 +1447,7 @@ List entries of the branch.
|
|
|
1449
1447
|
|
|
1450
1448
|
#### Parameters
|
|
1451
1449
|
|
|
1452
|
-
* `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)
|
|
1450
|
+
* `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)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))?** 
|
|
1453
1451
|
|
|
1454
1452
|
Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
|
|
1455
1453
|
|
|
@@ -1467,7 +1465,7 @@ Get exactly one matching entry by name or undefine if no such entry is found.
|
|
|
1467
1465
|
|
|
1468
1466
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1469
1467
|
|
|
1470
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
|
|
1468
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([ContentEntry](#contententry) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1471
1469
|
|
|
1472
1470
|
### entry
|
|
1473
1471
|
|
|
@@ -1559,7 +1557,7 @@ Abstract repository collection.
|
|
|
1559
1557
|
|
|
1560
1558
|
* `provider` **[BaseProvider](#baseprovider)** 
|
|
1561
1559
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
|
|
1562
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1560
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1563
1561
|
|
|
1564
1562
|
* `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable description
|
|
1565
1563
|
* `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** internal id
|
|
@@ -1591,7 +1589,7 @@ Mixin to define a class able to handle a collection of repositories.
|
|
|
1591
1589
|
|
|
1592
1590
|
### Parameters
|
|
1593
1591
|
|
|
1594
|
-
* `base` **
|
|
1592
|
+
* `base` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be extendet
|
|
1595
1593
|
|
|
1596
1594
|
## Repository
|
|
1597
1595
|
|
|
@@ -1601,7 +1599,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
|
|
|
1601
1599
|
|
|
1602
1600
|
* `owner` **[RepositoryOwner](#repositoryowner)** 
|
|
1603
1601
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (#branch) will be removed
|
|
1604
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1602
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1605
1603
|
|
|
1606
1604
|
* `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable description
|
|
1607
1605
|
* `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** internal id
|
|
@@ -1642,7 +1640,7 @@ List entries of the default branch.
|
|
|
1642
1640
|
|
|
1643
1641
|
#### Parameters
|
|
1644
1642
|
|
|
1645
|
-
* `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)
|
|
1643
|
+
* `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)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
|
|
1646
1644
|
|
|
1647
1645
|
Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
|
|
1648
1646
|
|
|
@@ -1654,7 +1652,7 @@ Get exactly one matching entry by name or undefined if no such entry is found.
|
|
|
1654
1652
|
|
|
1655
1653
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1656
1654
|
|
|
1657
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
|
|
1655
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([ContentEntry](#contententry) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1658
1656
|
|
|
1659
1657
|
### commits
|
|
1660
1658
|
|
|
@@ -1662,7 +1660,7 @@ List commits of the default branch.
|
|
|
1662
1660
|
|
|
1663
1661
|
#### Parameters
|
|
1664
1662
|
|
|
1665
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1663
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1666
1664
|
|
|
1667
1665
|
Returns **AsyncIterator<[Commit](#commit)>** all matching commits in the repository
|
|
1668
1666
|
|
|
@@ -1719,7 +1717,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
1719
1717
|
|
|
1720
1718
|
Lookup the default branch.
|
|
1721
1719
|
|
|
1722
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** branch named after defaultBranchName
|
|
1720
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Branch](#branch) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** branch named after defaultBranchName
|
|
1723
1721
|
|
|
1724
1722
|
### branch
|
|
1725
1723
|
|
|
@@ -1729,7 +1727,7 @@ Lookup branch by name.
|
|
|
1729
1727
|
|
|
1730
1728
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1731
1729
|
|
|
1732
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** 
|
|
1730
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Branch](#branch) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1733
1731
|
|
|
1734
1732
|
### hasBranches
|
|
1735
1733
|
|
|
@@ -1739,7 +1737,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
1739
1737
|
|
|
1740
1738
|
#### Parameters
|
|
1741
1739
|
|
|
1742
|
-
* `patterns`
|
|
1740
|
+
* `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))** 
|
|
1743
1741
|
|
|
1744
1742
|
Returns **AsyncIterator<[Branch](#branch)>** of all branches
|
|
1745
1743
|
|
|
@@ -1751,7 +1749,7 @@ Create a new [Branch](#branch) by cloning a given source branch.
|
|
|
1751
1749
|
|
|
1752
1750
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch
|
|
1753
1751
|
* `source` **[Branch](#branch)** branch defaults to the defaultBranch
|
|
1754
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1752
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1755
1753
|
|
|
1756
1754
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** newly created branch (or already present old one with the same name)
|
|
1757
1755
|
|
|
@@ -1763,7 +1761,7 @@ Internal branch creation does not call repository.initialize()
|
|
|
1763
1761
|
#### Parameters
|
|
1764
1762
|
|
|
1765
1763
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch
|
|
1766
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be passed to the branch
|
|
1764
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** to be passed to the branch
|
|
1767
1765
|
|
|
1768
1766
|
Returns **[Branch](#branch)** newly created branch
|
|
1769
1767
|
|
|
@@ -1791,7 +1789,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
1791
1789
|
|
|
1792
1790
|
#### Parameters
|
|
1793
1791
|
|
|
1794
|
-
* `patterns` **([
|
|
1792
|
+
* `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))** 
|
|
1795
1793
|
|
|
1796
1794
|
Returns **AsyncIterator<[Tag](#tag)>** of all tags
|
|
1797
1795
|
|
|
@@ -1803,7 +1801,7 @@ Internal tag creation does not call repository.initialize()
|
|
|
1803
1801
|
#### Parameters
|
|
1804
1802
|
|
|
1805
1803
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new tag
|
|
1806
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1804
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1807
1805
|
|
|
1808
1806
|
Returns **[Tag](#tag)** newly created tag
|
|
1809
1807
|
|
|
@@ -1815,7 +1813,7 @@ Create a pull request (or deliver an already present for the given name).
|
|
|
1815
1813
|
|
|
1816
1814
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the pr
|
|
1817
1815
|
* `source` **[Branch](#branch)** branch
|
|
1818
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1816
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1819
1817
|
|
|
1820
1818
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>** 
|
|
1821
1819
|
|
|
@@ -1827,7 +1825,7 @@ Add a pull request.
|
|
|
1827
1825
|
|
|
1828
1826
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1829
1827
|
* `source` **[Branch](#branch)** 
|
|
1830
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1828
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1831
1829
|
|
|
1832
1830
|
Returns **[PullRequest](#pullrequest)** 
|
|
1833
1831
|
|
|
@@ -1839,13 +1837,13 @@ Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
|
|
|
1839
1837
|
|
|
1840
1838
|
### pullRequest
|
|
1841
1839
|
|
|
1842
|
-
The @
|
|
1840
|
+
The @see [PullRequest](#pullrequest) for a given name.
|
|
1843
1841
|
|
|
1844
1842
|
#### Parameters
|
|
1845
1843
|
|
|
1846
1844
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1847
1845
|
|
|
1848
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>** 
|
|
1846
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([PullRequest](#pullrequest) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** 
|
|
1849
1847
|
|
|
1850
1848
|
### deletePullRequest
|
|
1851
1849
|
|
|
@@ -1864,7 +1862,7 @@ Add a new [Hook](#hook).
|
|
|
1864
1862
|
#### Parameters
|
|
1865
1863
|
|
|
1866
1864
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new hoook name
|
|
1867
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1865
|
+
* `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1868
1866
|
|
|
1869
1867
|
Returns **[Hook](#hook)** newly created hook
|
|
1870
1868
|
|
|
@@ -1890,7 +1888,37 @@ Get a Hook.
|
|
|
1890
1888
|
|
|
1891
1889
|
* `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))** 
|
|
1892
1890
|
|
|
1893
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Hook](#hook)>** for the given id
|
|
1891
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Hook](#hook) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given id
|
|
1892
|
+
|
|
1893
|
+
### milestone
|
|
1894
|
+
|
|
1895
|
+
Get a Milestone.
|
|
1896
|
+
|
|
1897
|
+
#### Parameters
|
|
1898
|
+
|
|
1899
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1900
|
+
|
|
1901
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Milestone](#milestone) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given name
|
|
1902
|
+
|
|
1903
|
+
### project
|
|
1904
|
+
|
|
1905
|
+
Get a Project.
|
|
1906
|
+
|
|
1907
|
+
#### Parameters
|
|
1908
|
+
|
|
1909
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1910
|
+
|
|
1911
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Project](#project) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given name
|
|
1912
|
+
|
|
1913
|
+
### application
|
|
1914
|
+
|
|
1915
|
+
Get an Application.
|
|
1916
|
+
|
|
1917
|
+
#### Parameters
|
|
1918
|
+
|
|
1919
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1920
|
+
|
|
1921
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Application](#application) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given name
|
|
1894
1922
|
|
|
1895
1923
|
### type
|
|
1896
1924
|
|
|
@@ -1906,7 +1934,7 @@ Get sha of a ref.
|
|
|
1906
1934
|
|
|
1907
1935
|
* `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1908
1936
|
|
|
1909
|
-
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
|
|
1937
|
+
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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** sha of the ref
|
|
1910
1938
|
|
|
1911
1939
|
### attributes
|
|
1912
1940
|
|
|
@@ -1954,7 +1982,7 @@ List groups.
|
|
|
1954
1982
|
|
|
1955
1983
|
#### Parameters
|
|
1956
1984
|
|
|
1957
|
-
* `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))** 
|
|
1985
|
+
* `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) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1958
1986
|
|
|
1959
1987
|
Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
|
|
1960
1988
|
|
|
@@ -1975,7 +2003,7 @@ The value undefined will be represented as an empty array.
|
|
|
1975
2003
|
|
|
1976
2004
|
### Parameters
|
|
1977
2005
|
|
|
1978
|
-
* `value` **(
|
|
2006
|
+
* `value` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | any)** 
|
|
1979
2007
|
|
|
1980
2008
|
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** value encapsulated in an array
|
|
1981
2009
|
|
|
@@ -1986,11 +2014,11 @@ A URL auth component will be removed to.
|
|
|
1986
2014
|
|
|
1987
2015
|
### Parameters
|
|
1988
2016
|
|
|
1989
|
-
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
2017
|
+
* `name` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
1990
2018
|
* `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
|
|
1991
2019
|
* `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
|
|
1992
2020
|
|
|
1993
|
-
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name without base
|
|
2021
|
+
Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** name without base
|
|
1994
2022
|
|
|
1995
2023
|
## stripBaseNames
|
|
1996
2024
|
|
|
@@ -1998,7 +2026,7 @@ Loops over names and executes stripBaseName.
|
|
|
1998
2026
|
|
|
1999
2027
|
### Parameters
|
|
2000
2028
|
|
|
2001
|
-
* `names` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [
|
|
2029
|
+
* `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)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
|
|
2002
2030
|
* `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
|
|
2003
2031
|
* `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
|
|
2004
2032
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "repository-provider",
|
|
3
|
-
"version": "32.7.
|
|
3
|
+
"version": "32.7.14",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -30,14 +30,14 @@
|
|
|
30
30
|
"lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --moduleResolution nodenext ./src/*.mjs"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"matching-iterator": "^2.0.
|
|
33
|
+
"matching-iterator": "^2.0.12"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"ava": "^5.2.0",
|
|
37
37
|
"browser-ava": "^1.3.38",
|
|
38
38
|
"c8": "^7.13.0",
|
|
39
39
|
"documentation": "^14.0.1",
|
|
40
|
-
"repository-provider-test-support": "^2.3.
|
|
40
|
+
"repository-provider-test-support": "^2.3.4",
|
|
41
41
|
"semantic-release": "^21.0.2",
|
|
42
42
|
"typescript": "^5.0.4"
|
|
43
43
|
},
|
package/src/base-object.mjs
CHANGED
|
@@ -127,7 +127,7 @@ import { description_attribute, id_attribute } from "./attributes.mjs";
|
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
129
|
* Check for equality
|
|
130
|
-
* @param {BaseObject} other
|
|
130
|
+
* @param {BaseObject|undefined} other
|
|
131
131
|
* @return {boolean} true if other is present
|
|
132
132
|
*/
|
|
133
133
|
equals(other) {
|
package/src/base-provider.mjs
CHANGED
|
@@ -35,6 +35,8 @@ export class BaseProvider extends BaseObject {
|
|
|
35
35
|
}
|
|
36
36
|
|
|
37
37
|
/**
|
|
38
|
+
* Prefix used to form environment variables.
|
|
39
|
+
* 'GITHUB_' -> 'GITHUB_TOKEN'
|
|
38
40
|
* @return {string} identifier for environment options
|
|
39
41
|
*/
|
|
40
42
|
static get instanceIdentifier() {
|
|
@@ -42,10 +44,10 @@ export class BaseProvider extends BaseObject {
|
|
|
42
44
|
}
|
|
43
45
|
|
|
44
46
|
/**
|
|
45
|
-
* Extract options suitable for the constructor
|
|
46
|
-
*
|
|
47
|
+
* Extract options suitable for the constructor.
|
|
48
|
+
* Form the given set of environment variables.
|
|
47
49
|
* Object with the detected key value pairs is delivered.
|
|
48
|
-
* @param {Object} env as from process.env
|
|
50
|
+
* @param {Object|undefined} env as from process.env
|
|
49
51
|
* @param {string} instanceIdentifier part of variable name.
|
|
50
52
|
* @return {Object|undefined} undefined if no suitable environment variables have been found
|
|
51
53
|
*/
|
|
@@ -152,6 +154,7 @@ export class BaseProvider extends BaseObject {
|
|
|
152
154
|
}
|
|
153
155
|
|
|
154
156
|
/**
|
|
157
|
+
* @param {*} other
|
|
155
158
|
* @return {boolean} true if other provider is the same as the receiver
|
|
156
159
|
*/
|
|
157
160
|
equals(other) {
|
|
@@ -166,6 +169,7 @@ export class BaseProvider extends BaseObject {
|
|
|
166
169
|
* - git+ssh://github.com
|
|
167
170
|
* - https://github.com
|
|
168
171
|
* - git+https://github.com
|
|
172
|
+
* By default we provide provider name with ':'.
|
|
169
173
|
* @return {string[]} common base urls of all repositories
|
|
170
174
|
*/
|
|
171
175
|
get repositoryBases() {
|
|
@@ -174,7 +178,7 @@ export class BaseProvider extends BaseObject {
|
|
|
174
178
|
|
|
175
179
|
/**
|
|
176
180
|
* Does the provider support the base name.
|
|
177
|
-
* @param {string} base to be checked
|
|
181
|
+
* @param {string|undefined} base to be checked
|
|
178
182
|
* @return {boolean} true if base is supported or base is undefined
|
|
179
183
|
*/
|
|
180
184
|
supportsBase(base) {
|
|
@@ -183,7 +187,7 @@ export class BaseProvider extends BaseObject {
|
|
|
183
187
|
|
|
184
188
|
/**
|
|
185
189
|
* Bring a repository name into its normal form by removing any clutter.
|
|
186
|
-
*
|
|
190
|
+
* Like .git suffix or #branch names.
|
|
187
191
|
* @param {string} name
|
|
188
192
|
* @param {boolean} forLookup
|
|
189
193
|
* @return {string} normalized name
|
|
@@ -197,7 +201,7 @@ export class BaseProvider extends BaseObject {
|
|
|
197
201
|
|
|
198
202
|
/**
|
|
199
203
|
* Bring a group name into its normal form by removing any clutter.
|
|
200
|
-
*
|
|
204
|
+
* Like .git suffix or #branch names.
|
|
201
205
|
* @param {string} name
|
|
202
206
|
* @param {boolean} forLookup
|
|
203
207
|
* @return {string} normalized name
|
|
@@ -211,7 +215,7 @@ export class BaseProvider extends BaseObject {
|
|
|
211
215
|
|
|
212
216
|
/**
|
|
213
217
|
* Are repository names case sensitive.
|
|
214
|
-
* Overwrite and return false if you want to have case insensitive repository lookup
|
|
218
|
+
* Overwrite and return false if you want to have case insensitive repository lookup.
|
|
215
219
|
* @return {boolean} true
|
|
216
220
|
*/
|
|
217
221
|
get areRepositoryNamesCaseSensitive() {
|
|
@@ -220,7 +224,7 @@ export class BaseProvider extends BaseObject {
|
|
|
220
224
|
|
|
221
225
|
/**
|
|
222
226
|
* Are repositroy group names case sensitive.
|
|
223
|
-
* Overwrite and return false if you want to have case insensitive group lookup
|
|
227
|
+
* Overwrite and return false if you want to have case insensitive group lookup.
|
|
224
228
|
* @return {boolean} true
|
|
225
229
|
*/
|
|
226
230
|
get areGroupNamesCaseSensitive() {
|
|
@@ -230,7 +234,7 @@ export class BaseProvider extends BaseObject {
|
|
|
230
234
|
/**
|
|
231
235
|
* Parses repository name and tries to split it into
|
|
232
236
|
* base, group, repository and branch.
|
|
233
|
-
* @param {string} name
|
|
237
|
+
* @param {string|undefined} name
|
|
234
238
|
* @param {string} focus where lies the focus if only one path component is given
|
|
235
239
|
* @return {Object} with separated attributes
|
|
236
240
|
*/
|
|
@@ -288,7 +292,7 @@ export class BaseProvider extends BaseObject {
|
|
|
288
292
|
/**
|
|
289
293
|
* Create a repository.
|
|
290
294
|
* @param {string} name of group and repository
|
|
291
|
-
* @param {Object} options
|
|
295
|
+
* @param {Object|undefined} options
|
|
292
296
|
* @returns {Promise<Repository>}
|
|
293
297
|
*/
|
|
294
298
|
async createRepository(name, options) {
|
|
@@ -301,7 +305,7 @@ export class BaseProvider extends BaseObject {
|
|
|
301
305
|
* List provider objects of a given type.
|
|
302
306
|
*
|
|
303
307
|
* @param {string} type name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
|
|
304
|
-
* @param {string[]|string} patterns group / repository filter
|
|
308
|
+
* @param {string[]|string|undefined} patterns group / repository filter
|
|
305
309
|
*/
|
|
306
310
|
async *list(type, patterns) {
|
|
307
311
|
if (patterns === undefined) {
|
|
@@ -324,7 +328,7 @@ export class BaseProvider extends BaseObject {
|
|
|
324
328
|
|
|
325
329
|
/**
|
|
326
330
|
* List projects.
|
|
327
|
-
* @param {string[]|string} patterns
|
|
331
|
+
* @param {string[]|string|undefined} patterns
|
|
328
332
|
* @return {AsyncIterator<Project>} all matching projects of the provider
|
|
329
333
|
*/
|
|
330
334
|
async *projects(patterns) {
|
|
@@ -333,7 +337,7 @@ export class BaseProvider extends BaseObject {
|
|
|
333
337
|
|
|
334
338
|
/**
|
|
335
339
|
* List milestones.
|
|
336
|
-
* @param {string[]|string} patterns
|
|
340
|
+
* @param {string[]|string|undefined} patterns
|
|
337
341
|
* @return {AsyncIterator<Milestone>} all matching milestones of the provider
|
|
338
342
|
*/
|
|
339
343
|
async *milestones(patterns) {
|
|
@@ -342,7 +346,7 @@ export class BaseProvider extends BaseObject {
|
|
|
342
346
|
|
|
343
347
|
/**
|
|
344
348
|
* List repositories.
|
|
345
|
-
* @param {string[]|string} patterns
|
|
349
|
+
* @param {string[]|string|undefined} patterns
|
|
346
350
|
* @return {AsyncIterator<Repository>} all matching repos of the provider
|
|
347
351
|
*/
|
|
348
352
|
async *repositories(patterns) {
|
|
@@ -351,7 +355,7 @@ export class BaseProvider extends BaseObject {
|
|
|
351
355
|
|
|
352
356
|
/**
|
|
353
357
|
* List branches.
|
|
354
|
-
* @param {string[]|string} patterns
|
|
358
|
+
* @param {string[]|string|undefined} patterns
|
|
355
359
|
* @return {AsyncIterator<Branch>} all matching branches of the provider
|
|
356
360
|
*/
|
|
357
361
|
async *branches(patterns) {
|
|
@@ -360,7 +364,7 @@ export class BaseProvider extends BaseObject {
|
|
|
360
364
|
|
|
361
365
|
/**
|
|
362
366
|
* List tags.
|
|
363
|
-
* @param {string[]|string} patterns
|
|
367
|
+
* @param {string[]|string|undefined} patterns
|
|
364
368
|
* @return {AsyncIterator<Tag>} all matching tags of the provider
|
|
365
369
|
*/
|
|
366
370
|
async *tags(patterns) {
|
|
@@ -369,7 +373,7 @@ export class BaseProvider extends BaseObject {
|
|
|
369
373
|
|
|
370
374
|
/**
|
|
371
375
|
* List hooks.
|
|
372
|
-
* @param {string[]|string} patterns
|
|
376
|
+
* @param {string[]|string|undefined} patterns
|
|
373
377
|
* @return {AsyncIterator<Hook>} all matching hooks of the provider
|
|
374
378
|
*/
|
|
375
379
|
async *hooks(patterns) {
|
|
@@ -378,7 +382,7 @@ export class BaseProvider extends BaseObject {
|
|
|
378
382
|
|
|
379
383
|
/**
|
|
380
384
|
* List pull requests.
|
|
381
|
-
* @param {string[]|string} patterns
|
|
385
|
+
* @param {string[]|string|undefined} patterns
|
|
382
386
|
* @return {AsyncIterator<PullRequest>} all matching pullRequests of the provider
|
|
383
387
|
*/
|
|
384
388
|
async *pullRequests(patterns) {
|
|
@@ -444,49 +448,49 @@ export class BaseProvider extends BaseObject {
|
|
|
444
448
|
}
|
|
445
449
|
|
|
446
450
|
/**
|
|
447
|
-
* @return {
|
|
451
|
+
* @return {typeof RepositoryGroup} repository group class used by the Provider
|
|
448
452
|
*/
|
|
449
453
|
get repositoryGroupClass() {
|
|
450
454
|
return RepositoryGroup;
|
|
451
455
|
}
|
|
452
456
|
|
|
453
457
|
/**
|
|
454
|
-
* @return {
|
|
458
|
+
* @return {typeof Hook} hook class used by the Provider
|
|
455
459
|
*/
|
|
456
460
|
get hookClass() {
|
|
457
461
|
return Hook;
|
|
458
462
|
}
|
|
459
463
|
|
|
460
464
|
/**
|
|
461
|
-
* @return {
|
|
465
|
+
* @return {typeof Repository} repository class used by the Provider
|
|
462
466
|
*/
|
|
463
467
|
get repositoryClass() {
|
|
464
468
|
return Repository;
|
|
465
469
|
}
|
|
466
470
|
|
|
467
471
|
/**
|
|
468
|
-
* @return {
|
|
472
|
+
* @return {typeof Branch} branch class used by the Provider
|
|
469
473
|
*/
|
|
470
474
|
get branchClass() {
|
|
471
475
|
return Branch;
|
|
472
476
|
}
|
|
473
477
|
|
|
474
478
|
/**
|
|
475
|
-
* @return {
|
|
479
|
+
* @return {typeof Tag} branch class used by the Provider
|
|
476
480
|
*/
|
|
477
481
|
get tagClass() {
|
|
478
482
|
return Tag;
|
|
479
483
|
}
|
|
480
484
|
|
|
481
485
|
/**
|
|
482
|
-
* @return {
|
|
486
|
+
* @return {typeof ContentEntry} entry class used by the Provider
|
|
483
487
|
*/
|
|
484
488
|
get entryClass() {
|
|
485
489
|
return undefined;
|
|
486
490
|
}
|
|
487
491
|
|
|
488
492
|
/**
|
|
489
|
-
* @return {
|
|
493
|
+
* @return {typeof PullRequest} pull request class used by the Provider
|
|
490
494
|
*/
|
|
491
495
|
get pullRequestClass() {
|
|
492
496
|
return PullRequest;
|
package/src/branch.mjs
CHANGED
|
@@ -182,7 +182,7 @@ export class Branch extends Ref {
|
|
|
182
182
|
/**
|
|
183
183
|
* Create a pull request.
|
|
184
184
|
* @param {Branch} toBranch
|
|
185
|
-
* @param {Object} options
|
|
185
|
+
* @param {Object|undefined} options
|
|
186
186
|
* @return {Promise<PullRequest>}
|
|
187
187
|
*/
|
|
188
188
|
async createPullRequest(toBranch, options) {
|
package/src/ref.mjs
CHANGED
|
@@ -54,7 +54,7 @@ export class Ref extends OwnedObject {
|
|
|
54
54
|
|
|
55
55
|
/**
|
|
56
56
|
* List entries of the branch.
|
|
57
|
-
* @param {string|string
|
|
57
|
+
* @param {string[]|string|undefined} [matchingPatterns]
|
|
58
58
|
* @return {AsyncIterator<ContentEntry>} all matching entries in the branch
|
|
59
59
|
*/
|
|
60
60
|
async *entries(matchingPatterns) {}
|
package/src/repository-owner.mjs
CHANGED
|
@@ -41,7 +41,7 @@ export function RepositoryOwner(base) {
|
|
|
41
41
|
|
|
42
42
|
/**
|
|
43
43
|
* Lookup a repository.
|
|
44
|
-
* @param {string} name of the repository may contain a #branch
|
|
44
|
+
* @param {string|undefined} name of the repository may contain a #branch
|
|
45
45
|
* @return {Promise<Repository|undefined>}
|
|
46
46
|
*/
|
|
47
47
|
async repository(name) {
|
|
@@ -53,7 +53,7 @@ export function RepositoryOwner(base) {
|
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
55
|
* List repositories for the owner.
|
|
56
|
-
* @param {string[]|string} patterns
|
|
56
|
+
* @param {string[]|string|undefined} patterns
|
|
57
57
|
* @return {AsyncIterator<Repository>} all matching repositories of the owner
|
|
58
58
|
*/
|
|
59
59
|
async *repositories(patterns) {
|
|
@@ -84,10 +84,10 @@ export function RepositoryOwner(base) {
|
|
|
84
84
|
/**
|
|
85
85
|
* Lookup entity of a given type and name.
|
|
86
86
|
* @param {string} type
|
|
87
|
-
* @param {string} name
|
|
87
|
+
* @param {string|undefined} name
|
|
88
88
|
* @param {function} [split]
|
|
89
89
|
* @param {Object} [defaultItem]
|
|
90
|
-
* @returns {Promise<NamedObject>} from a repository
|
|
90
|
+
* @returns {Promise<NamedObject|undefined>} from a repository
|
|
91
91
|
*/
|
|
92
92
|
async lookup(type, name, split, defaultItem) {
|
|
93
93
|
if (name !== undefined) {
|
|
@@ -147,7 +147,7 @@ export function RepositoryOwner(base) {
|
|
|
147
147
|
* Create a new {@link Repository} in the provider.
|
|
148
148
|
* If there is already if repository for the given name it will be returned.
|
|
149
149
|
* @param {string} name
|
|
150
|
-
* @param {Object} options
|
|
150
|
+
* @param {Object|undefined} options
|
|
151
151
|
* @return {Promise<Repository>} newly created repository (if not already present)
|
|
152
152
|
*/
|
|
153
153
|
async createRepository(name, options) {
|
|
@@ -158,7 +158,7 @@ export function RepositoryOwner(base) {
|
|
|
158
158
|
* Add a {@link Repository} to the group.
|
|
159
159
|
* Only adds the repository to the in memory representation (does not execute any provider actions).
|
|
160
160
|
* @param {string} name
|
|
161
|
-
* @param {Object} options
|
|
161
|
+
* @param {Object|undefined} options
|
|
162
162
|
* @return {Promise<Repository>} newly created repository
|
|
163
163
|
*/
|
|
164
164
|
addRepository(name, options) {
|
package/src/repository.mjs
CHANGED
|
@@ -97,6 +97,11 @@ export class Repository extends OwnedObject {
|
|
|
97
97
|
return `${this.provider.url}${this.slug}`;
|
|
98
98
|
}
|
|
99
99
|
|
|
100
|
+
get defaultBranchName()
|
|
101
|
+
{
|
|
102
|
+
return "master";
|
|
103
|
+
}
|
|
104
|
+
|
|
100
105
|
/**
|
|
101
106
|
* Lookup entries form the head of the default branch.
|
|
102
107
|
* {@link Branch#entry}
|
|
@@ -35,7 +35,7 @@ export class SingleGroupProvider extends RepositoryOwner(BaseProvider) {
|
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
37
|
* List groups.
|
|
38
|
-
* @param {string[]|string} patterns
|
|
38
|
+
* @param {string[]|string|undefined} patterns
|
|
39
39
|
* @return {AsyncIterator<RepositoryGroup>} always deliver the one and only present group
|
|
40
40
|
*/
|
|
41
41
|
async *repositoryGroups(patterns) {
|