repository-provider 35.2.3 → 35.2.4

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.
Files changed (3) hide show
  1. package/README.md +923 -253
  2. package/package.json +4 -4
  3. package/src/index.mjs +10 -0
package/README.md CHANGED
@@ -79,10 +79,7 @@ console.log(await readme.string);
79
79
  * [attributes](#attributes)
80
80
  * [writableAttributes](#writableattributes)
81
81
  * [attributeMapping](#attributemapping)
82
- * [MessageDestination](#messagedestination)
83
- * [Properties](#properties-1)
84
82
  * [BaseProvider](#baseprovider)
85
- * [Properties](#properties-2)
86
83
  * [equals](#equals-1)
87
84
  * [Parameters](#parameters-8)
88
85
  * [repositoryBases](#repositorybases)
@@ -131,10 +128,62 @@ console.log(await readme.string);
131
128
  * [Parameters](#parameters-23)
132
129
  * [initialize](#initialize)
133
130
  * [Parameters](#parameters-24)
134
- * [name](#name-1)
131
+ * [BaseProvider](#baseprovider-1)
132
+ * [Properties](#properties-1)
133
+ * [equals](#equals-2)
134
+ * [Parameters](#parameters-25)
135
+ * [repositoryBases](#repositorybases-1)
136
+ * [supportsBase](#supportsbase-1)
137
+ * [Parameters](#parameters-26)
138
+ * [normalizeRepositoryName](#normalizerepositoryname-1)
139
+ * [Parameters](#parameters-27)
140
+ * [normalizeGroupName](#normalizegroupname-1)
141
+ * [Parameters](#parameters-28)
142
+ * [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive-1)
143
+ * [areGroupNamesCaseSensitive](#aregroupnamescasesensitive-1)
144
+ * [parseName](#parsename-1)
145
+ * [Parameters](#parameters-29)
146
+ * [createRepository](#createrepository-1)
147
+ * [Parameters](#parameters-30)
148
+ * [list](#list-1)
149
+ * [Parameters](#parameters-31)
150
+ * [projects](#projects-1)
151
+ * [Parameters](#parameters-32)
152
+ * [milestones](#milestones-1)
153
+ * [Parameters](#parameters-33)
154
+ * [repositories](#repositories-1)
155
+ * [Parameters](#parameters-34)
156
+ * [branches](#branches-1)
157
+ * [Parameters](#parameters-35)
158
+ * [tags](#tags-1)
159
+ * [Parameters](#parameters-36)
160
+ * [hooks](#hooks-1)
161
+ * [Parameters](#parameters-37)
162
+ * [pullRequests](#pullrequests-1)
163
+ * [Parameters](#parameters-38)
164
+ * [name](#name-1)
165
+ * [provider](#provider-1)
166
+ * [toJSON](#tojson-1)
167
+ * [repositoryGroupClass](#repositorygroupclass-1)
168
+ * [hookClass](#hookclass-1)
169
+ * [repositoryClass](#repositoryclass-1)
170
+ * [branchClass](#branchclass-1)
171
+ * [tagClass](#tagclass-1)
172
+ * [entryClass](#entryclass-1)
173
+ * [pullRequestClass](#pullrequestclass-1)
174
+ * [instanceIdentifier](#instanceidentifier-1)
175
+ * [optionsFromEnvironment](#optionsfromenvironment-1)
176
+ * [Parameters](#parameters-39)
177
+ * [areOptionsSufficcient](#areoptionssufficcient-1)
178
+ * [Parameters](#parameters-40)
179
+ * [initialize](#initialize-1)
180
+ * [Parameters](#parameters-41)
181
+ * [MessageDestination](#messagedestination)
182
+ * [Properties](#properties-2)
183
+ * [name](#name-2)
135
184
  * [messageDestination](#messagedestination-1)
136
185
  * [Branch](#branch)
137
- * [Parameters](#parameters-25)
186
+ * [Parameters](#parameters-42)
138
187
  * [Properties](#properties-3)
139
188
  * [url](#url)
140
189
  * [refType](#reftype)
@@ -142,51 +191,59 @@ console.log(await readme.string);
142
191
  * [isDefault](#isdefault)
143
192
  * [delete](#delete)
144
193
  * [commit](#commit)
145
- * [Parameters](#parameters-26)
194
+ * [Parameters](#parameters-43)
146
195
  * [commitIntoPullRequest](#commitintopullrequest)
147
- * [Parameters](#parameters-27)
196
+ * [Parameters](#parameters-44)
148
197
  * [removeEntries](#removeentries)
149
- * [Parameters](#parameters-28)
198
+ * [Parameters](#parameters-45)
150
199
  * [createPullRequest](#createpullrequest)
151
- * [Parameters](#parameters-29)
200
+ * [Parameters](#parameters-46)
152
201
  * [createBranch](#createbranch)
153
- * [Parameters](#parameters-30)
202
+ * [Parameters](#parameters-47)
154
203
  * [CommitResult](#commitresult)
155
- * [Parameters](#parameters-31)
204
+ * [Parameters](#parameters-48)
156
205
  * [Properties](#properties-4)
157
206
  * [Commit](#commit-1)
158
- * [Parameters](#parameters-32)
207
+ * [Parameters](#parameters-49)
159
208
  * [Properties](#properties-5)
160
209
  * [Hook](#hook)
161
210
  * [Issue](#issue)
162
211
  * [Milestone](#milestone)
163
212
  * [MultiGroupProvider](#multigroupprovider)
164
213
  * [repository](#repository)
165
- * [Parameters](#parameters-33)
214
+ * [Parameters](#parameters-50)
166
215
  * [branch](#branch-1)
167
- * [Parameters](#parameters-34)
216
+ * [Parameters](#parameters-51)
168
217
  * [repositoryGroup](#repositorygroup)
169
- * [Parameters](#parameters-35)
218
+ * [Parameters](#parameters-52)
170
219
  * [repositoryGroups](#repositorygroups)
171
- * [Parameters](#parameters-36)
220
+ * [Parameters](#parameters-53)
172
221
  * [createRepositoryGroup](#createrepositorygroup)
173
- * [Parameters](#parameters-37)
222
+ * [Parameters](#parameters-54)
174
223
  * [addRepositoryGroup](#addrepositorygroup)
175
- * [Parameters](#parameters-38)
224
+ * [Parameters](#parameters-55)
176
225
  * [NamedObject](#namedobject)
177
- * [Parameters](#parameters-39)
178
- * [Properties](#properties-6)
226
+ * [Parameters](#parameters-56)
179
227
  * [displayName](#displayname)
180
228
  * [condensedName](#condensedname)
181
229
  * [fullCondensedName](#fullcondensedname)
182
- * [equals](#equals-2)
183
- * [Parameters](#parameters-40)
184
- * [toJSON](#tojson-1)
230
+ * [equals](#equals-3)
231
+ * [Parameters](#parameters-57)
232
+ * [toJSON](#tojson-2)
233
+ * [NamedObject](#namedobject-1)
234
+ * [Parameters](#parameters-58)
235
+ * [Properties](#properties-6)
236
+ * [displayName](#displayname-1)
237
+ * [condensedName](#condensedname-1)
238
+ * [fullCondensedName](#fullcondensedname-1)
239
+ * [equals](#equals-4)
240
+ * [Parameters](#parameters-59)
241
+ * [toJSON](#tojson-3)
185
242
  * [OwnedObject](#ownedobject)
186
- * [Parameters](#parameters-41)
243
+ * [Parameters](#parameters-60)
187
244
  * [delete](#delete-1)
188
- * [equals](#equals-3)
189
- * [Parameters](#parameters-42)
245
+ * [equals](#equals-5)
246
+ * [Parameters](#parameters-61)
190
247
  * [homePageURL](#homepageurl)
191
248
  * [issuesURL](#issuesurl)
192
249
  * [isLocked](#islocked)
@@ -195,47 +252,81 @@ console.log(await readme.string);
195
252
  * [api](#api)
196
253
  * [slug](#slug)
197
254
  * [url](#url-1)
198
- * [provider](#provider-1)
255
+ * [provider](#provider-2)
199
256
  * [identifier](#identifier)
200
257
  * [fullName](#fullname-1)
201
258
  * [trace](#trace)
202
- * [Parameters](#parameters-43)
259
+ * [Parameters](#parameters-62)
203
260
  * [info](#info)
204
- * [Parameters](#parameters-44)
261
+ * [Parameters](#parameters-63)
205
262
  * [warn](#warn)
206
- * [Parameters](#parameters-45)
263
+ * [Parameters](#parameters-64)
207
264
  * [error](#error)
208
- * [Parameters](#parameters-46)
265
+ * [Parameters](#parameters-65)
209
266
  * [debug](#debug)
210
- * [Parameters](#parameters-47)
211
- * [repositoryClass](#repositoryclass-1)
212
- * [pullRequestClass](#pullrequestclass-1)
213
- * [branchClass](#branchclass-1)
214
- * [tagClass](#tagclass-1)
215
- * [entryClass](#entryclass-1)
216
- * [hookClass](#hookclass-1)
267
+ * [Parameters](#parameters-66)
268
+ * [repositoryClass](#repositoryclass-2)
269
+ * [pullRequestClass](#pullrequestclass-2)
270
+ * [branchClass](#branchclass-2)
271
+ * [tagClass](#tagclass-2)
272
+ * [entryClass](#entryclass-2)
273
+ * [hookClass](#hookclass-2)
217
274
  * [addMethodName](#addmethodname)
218
275
  * [deleteMethodName](#deletemethodname)
276
+ * [OwnedObject](#ownedobject-1)
277
+ * [Parameters](#parameters-67)
278
+ * [delete](#delete-2)
279
+ * [equals](#equals-6)
280
+ * [Parameters](#parameters-68)
281
+ * [homePageURL](#homepageurl-1)
282
+ * [issuesURL](#issuesurl-1)
283
+ * [isLocked](#islocked-1)
284
+ * [isArchived](#isarchived-1)
285
+ * [isDisabled](#isdisabled-1)
286
+ * [api](#api-1)
287
+ * [slug](#slug-1)
288
+ * [url](#url-2)
289
+ * [provider](#provider-3)
290
+ * [identifier](#identifier-1)
291
+ * [fullName](#fullname-2)
292
+ * [trace](#trace-1)
293
+ * [Parameters](#parameters-69)
294
+ * [info](#info-1)
295
+ * [Parameters](#parameters-70)
296
+ * [warn](#warn-1)
297
+ * [Parameters](#parameters-71)
298
+ * [error](#error-1)
299
+ * [Parameters](#parameters-72)
300
+ * [debug](#debug-1)
301
+ * [Parameters](#parameters-73)
302
+ * [repositoryClass](#repositoryclass-3)
303
+ * [pullRequestClass](#pullrequestclass-3)
304
+ * [branchClass](#branchclass-3)
305
+ * [tagClass](#tagclass-3)
306
+ * [entryClass](#entryclass-3)
307
+ * [hookClass](#hookclass-3)
308
+ * [addMethodName](#addmethodname-1)
309
+ * [deleteMethodName](#deletemethodname-1)
219
310
  * [Project](#project)
220
311
  * [PullRequest](#pullrequest)
221
- * [Parameters](#parameters-48)
312
+ * [Parameters](#parameters-74)
222
313
  * [Properties](#properties-7)
223
- * [fullName](#fullname-2)
224
- * [url](#url-2)
314
+ * [fullName](#fullname-3)
315
+ * [url](#url-3)
225
316
  * [repository](#repository-1)
226
- * [delete](#delete-2)
317
+ * [delete](#delete-3)
227
318
  * [merge](#merge)
228
- * [Parameters](#parameters-49)
319
+ * [Parameters](#parameters-75)
229
320
  * [decline](#decline)
230
321
  * [reviews](#reviews)
231
- * [identifier](#identifier-1)
322
+ * [identifier](#identifier-2)
232
323
  * [defaultListStates](#defaultliststates)
233
324
  * [states](#states)
234
325
  * [validMergeMethods](#validmergemethods)
235
- * [list](#list-1)
236
- * [Parameters](#parameters-50)
326
+ * [list](#list-2)
327
+ * [Parameters](#parameters-76)
237
328
  * [open](#open)
238
- * [Parameters](#parameters-51)
329
+ * [Parameters](#parameters-77)
239
330
  * [state](#state)
240
331
  * [locked](#locked)
241
332
  * [merged](#merged)
@@ -244,116 +335,132 @@ console.log(await readme.string);
244
335
  * [ref](#ref-1)
245
336
  * [refId](#refid)
246
337
  * [entries](#entries)
247
- * [Parameters](#parameters-52)
338
+ * [Parameters](#parameters-78)
248
339
  * [asyncIterator](#asynciterator)
249
340
  * [maybeEntry](#maybeentry)
250
- * [Parameters](#parameters-53)
341
+ * [Parameters](#parameters-79)
251
342
  * [entry](#entry)
252
- * [Parameters](#parameters-54)
343
+ * [Parameters](#parameters-80)
253
344
  * [repository](#repository-2)
254
- * [fullName](#fullname-3)
255
- * [fullCondensedName](#fullcondensedname-1)
345
+ * [fullName](#fullname-4)
346
+ * [fullCondensedName](#fullcondensedname-2)
256
347
  * [isProtected](#isprotected)
257
348
  * [isDefault](#isdefault-1)
258
349
  * [attributes](#attributes-1)
259
- * [isProtected](#isprotected-1)
350
+ * [Ref](#ref-2)
351
+ * [ref](#ref-3)
352
+ * [refId](#refid-1)
353
+ * [entries](#entries-1)
354
+ * [Parameters](#parameters-81)
355
+ * [asyncIterator](#asynciterator-1)
356
+ * [maybeEntry](#maybeentry-1)
357
+ * [Parameters](#parameters-82)
358
+ * [entry](#entry-1)
359
+ * [Parameters](#parameters-83)
360
+ * [repository](#repository-3)
361
+ * [fullName](#fullname-5)
362
+ * [fullCondensedName](#fullcondensedname-3)
363
+ * [isProtected](#isprotected-1)
364
+ * [isDefault](#isdefault-2)
365
+ * [attributes](#attributes-2)
366
+ * [isProtected](#isprotected-2)
260
367
  * [RepositoryGroup](#repositorygroup-1)
261
- * [Parameters](#parameters-55)
368
+ * [Parameters](#parameters-84)
262
369
  * [Properties](#properties-8)
263
370
  * [attributeMapping](#attributemapping-1)
264
371
  * [type](#type-1)
265
- * [homePageURL](#homepageurl-1)
372
+ * [homePageURL](#homepageurl-2)
266
373
  * [RepositoryOwner](#repositoryowner)
267
- * [Parameters](#parameters-56)
268
- * [Repository](#repository-3)
269
- * [Parameters](#parameters-57)
374
+ * [Parameters](#parameters-85)
375
+ * [Repository](#repository-4)
376
+ * [Parameters](#parameters-86)
270
377
  * [Properties](#properties-9)
271
- * [slug](#slug-1)
272
- * [entry](#entry-1)
273
- * [Parameters](#parameters-58)
274
- * [entries](#entries-1)
275
- * [Parameters](#parameters-59)
276
- * [maybeEntry](#maybeentry-1)
277
- * [Parameters](#parameters-60)
378
+ * [slug](#slug-2)
379
+ * [entry](#entry-2)
380
+ * [Parameters](#parameters-87)
381
+ * [entries](#entries-2)
382
+ * [Parameters](#parameters-88)
383
+ * [maybeEntry](#maybeentry-2)
384
+ * [Parameters](#parameters-89)
278
385
  * [commits](#commits)
279
- * [Parameters](#parameters-61)
386
+ * [Parameters](#parameters-90)
280
387
  * [cloneURL](#cloneurl)
281
- * [issuesURL](#issuesurl-1)
282
- * [homePageURL](#homepageurl-2)
283
- * [isArchived](#isarchived-1)
284
- * [isLocked](#islocked-1)
285
- * [isDisabled](#isdisabled-1)
388
+ * [issuesURL](#issuesurl-2)
389
+ * [homePageURL](#homepageurl-3)
390
+ * [isArchived](#isarchived-2)
391
+ * [isLocked](#islocked-2)
392
+ * [isDisabled](#isdisabled-2)
286
393
  * [isTemplate](#istemplate)
287
- * [delete](#delete-3)
394
+ * [delete](#delete-4)
288
395
  * [defaultBranch](#defaultbranch)
289
396
  * [branch](#branch-2)
290
- * [Parameters](#parameters-62)
397
+ * [Parameters](#parameters-91)
291
398
  * [hasBranches](#hasbranches)
292
- * [branches](#branches-1)
293
- * [Parameters](#parameters-63)
399
+ * [branches](#branches-2)
400
+ * [Parameters](#parameters-92)
294
401
  * [createBranch](#createbranch-1)
295
- * [Parameters](#parameters-64)
402
+ * [Parameters](#parameters-93)
296
403
  * [addBranch](#addbranch)
297
- * [Parameters](#parameters-65)
404
+ * [Parameters](#parameters-94)
298
405
  * [deleteBranch](#deletebranch)
299
- * [Parameters](#parameters-66)
406
+ * [Parameters](#parameters-95)
300
407
  * [tag](#tag)
301
- * [Parameters](#parameters-67)
302
- * [tags](#tags-1)
303
- * [Parameters](#parameters-68)
408
+ * [Parameters](#parameters-96)
409
+ * [tags](#tags-2)
410
+ * [Parameters](#parameters-97)
304
411
  * [addTag](#addtag)
305
- * [Parameters](#parameters-69)
412
+ * [Parameters](#parameters-98)
306
413
  * [createPullRequest](#createpullrequest-1)
307
- * [Parameters](#parameters-70)
414
+ * [Parameters](#parameters-99)
308
415
  * [addPullRequest](#addpullrequest)
309
- * [Parameters](#parameters-71)
310
- * [pullRequests](#pullrequests-1)
416
+ * [Parameters](#parameters-100)
417
+ * [pullRequests](#pullrequests-2)
311
418
  * [pullRequest](#pullrequest-1)
312
- * [Parameters](#parameters-72)
419
+ * [Parameters](#parameters-101)
313
420
  * [deletePullRequest](#deletepullrequest)
314
- * [Parameters](#parameters-73)
421
+ * [Parameters](#parameters-102)
315
422
  * [addHook](#addhook)
316
- * [Parameters](#parameters-74)
423
+ * [Parameters](#parameters-103)
317
424
  * [createHook](#createhook)
318
- * [Parameters](#parameters-75)
319
- * [hooks](#hooks-1)
425
+ * [Parameters](#parameters-104)
426
+ * [hooks](#hooks-2)
320
427
  * [hook](#hook-1)
321
- * [Parameters](#parameters-76)
428
+ * [Parameters](#parameters-105)
322
429
  * [milestone](#milestone-1)
323
- * [Parameters](#parameters-77)
430
+ * [Parameters](#parameters-106)
324
431
  * [project](#project-1)
325
- * [Parameters](#parameters-78)
432
+ * [Parameters](#parameters-107)
326
433
  * [application](#application-1)
327
- * [Parameters](#parameters-79)
434
+ * [Parameters](#parameters-108)
328
435
  * [type](#type-2)
329
- * [refId](#refid-1)
330
- * [Parameters](#parameters-80)
331
- * [attributes](#attributes-2)
436
+ * [refId](#refid-2)
437
+ * [Parameters](#parameters-109)
438
+ * [attributes](#attributes-3)
332
439
  * [defaultBranchName](#defaultbranchname)
333
- * [branches](#branches-2)
334
- * [tags](#tags-2)
335
- * [projects](#projects-1)
440
+ * [branches](#branches-3)
441
+ * [tags](#tags-3)
442
+ * [projects](#projects-2)
336
443
  * [applications](#applications)
337
- * [milestones](#milestones-1)
338
- * [pullRequests](#pullrequests-2)
444
+ * [milestones](#milestones-2)
445
+ * [pullRequests](#pullrequests-3)
339
446
  * [Review](#review)
340
447
  * [SingleGroupProvider](#singlegroupprovider)
341
- * [repository](#repository-4)
342
- * [Parameters](#parameters-81)
448
+ * [repository](#repository-5)
449
+ * [Parameters](#parameters-110)
343
450
  * [repositoryGroup](#repositorygroup-2)
344
- * [Parameters](#parameters-82)
451
+ * [Parameters](#parameters-111)
345
452
  * [repositoryGroups](#repositorygroups-1)
346
- * [Parameters](#parameters-83)
453
+ * [Parameters](#parameters-112)
347
454
  * [Tag](#tag-1)
348
455
  * [refType](#reftype-1)
349
456
  * [asArray](#asarray)
350
- * [Parameters](#parameters-84)
457
+ * [Parameters](#parameters-113)
351
458
  * [stripBaseName](#stripbasename)
352
- * [Parameters](#parameters-85)
459
+ * [Parameters](#parameters-114)
353
460
  * [stripBaseNames](#stripbasenames)
354
- * [Parameters](#parameters-86)
461
+ * [Parameters](#parameters-115)
355
462
  * [generateBranchName](#generatebranchname)
356
- * [Parameters](#parameters-87)
463
+ * [Parameters](#parameters-116)
357
464
 
358
465
  ## Application
359
466
 
@@ -547,26 +654,10 @@ Map attributes between external and internal representation.
547
654
 
548
655
  Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
549
656
 
550
- ## MessageDestination
551
-
552
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
553
-
554
- ### Properties
555
-
556
- * `info` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
557
- * `debug` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
558
- * `warn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
559
- * `error` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
560
- * `trace` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
561
-
562
657
  ## BaseProvider
563
658
 
564
659
  **Extends BaseObject**
565
660
 
566
- ### Properties
567
-
568
- * `messageDestination` **[MessageDestination](#messagedestination)** 
569
-
570
661
  ### equals
571
662
 
572
663
  #### Parameters
@@ -813,71 +904,337 @@ Creates a new provider for a given set of options.
813
904
 
814
905
  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
815
906
 
816
- ## name
907
+ ## BaseProvider
817
908
 
818
- Name of the provider.
909
+ **Extends BaseObject**
819
910
 
820
- ## messageDestination
911
+ ### Properties
821
912
 
822
- To forward info/warn and error messages to
913
+ * `messageDestination` **[MessageDestination](#messagedestination)** 
823
914
 
824
- ## Branch
915
+ ### equals
825
916
 
826
- * **See**: [Repository#\_addBranch](Repository#_addBranch)
917
+ #### Parameters
827
918
 
828
- Abstract branch.
919
+ * `other` **any** 
829
920
 
830
- ### Parameters
921
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other provider is the same as the receiver
831
922
 
832
- * `owner` **[RepositoryOwner](#repositoryowner)** 
833
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
834
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
923
+ ### repositoryBases
835
924
 
836
- ### Properties
925
+ All supported base urls.
926
+ For github something like:
837
927
 
838
- * `repository` **[Repository](#repository)** 
839
- * `provider` **Provider** 
840
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
928
+ * <git@github.com>
929
+ * git://github.com
930
+ * git+ssh://github.com
931
+ * <https://github.com>
932
+ * git+<https://github.com>
933
+ By default we provide provider name with ':'.
841
934
 
842
- ### url
935
+ 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
843
936
 
844
- Deliver repository and branch url combined.
937
+ ### supportsBase
845
938
 
846
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repoUrl#branch'
939
+ Does the provider support the base name.
847
940
 
848
- ### refType
941
+ #### Parameters
849
942
 
850
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** heades
943
+ * `base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** to be checked
851
944
 
852
- ### isWritable
945
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if base is supported or base is undefined
853
946
 
854
- Returns **any** true if not [isArchived](isArchived) and [isDisabled](isDisabled) and [isLocked](isLocked) and [isProtected](#isprotected)
947
+ ### normalizeRepositoryName
855
948
 
856
- ### isDefault
949
+ Bring a repository name into its normal form by removing any clutter.
950
+ Like .git suffix or #branch names.
857
951
 
858
- Are we the default branch.
952
+ #### Parameters
859
953
 
860
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name matches the repository default branch
954
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
955
+ * `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
861
956
 
862
- ### delete
957
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized name
863
958
 
864
- * **See**: [Repository#deleteBranch](#repositorydeletebranch)
959
+ ### normalizeGroupName
865
960
 
866
- Delete the branch from the [Repository](#repository).
961
+ Bring a group name into its normal form by removing any clutter.
962
+ Like .git suffix or #branch names.
867
963
 
868
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
964
+ #### Parameters
869
965
 
870
- ### commit
966
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
967
+ * `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
871
968
 
872
- Commit entries.
969
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized name
873
970
 
874
- #### Parameters
971
+ ### areRepositoryNamesCaseSensitive
972
+
973
+ Are repository names case sensitive.
974
+ Overwrite and return false if you want to have case insensitive repository lookup.
975
+
976
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
977
+
978
+ ### areGroupNamesCaseSensitive
979
+
980
+ Are repositroy group names case sensitive.
981
+ Overwrite and return false if you want to have case insensitive group lookup.
982
+
983
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
984
+
985
+ ### parseName
986
+
987
+ Parses repository name and tries to split it into
988
+ base, group, repository and branch.
989
+
990
+ #### Parameters
991
+
992
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
993
+ * `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"`)
994
+
995
+ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** with separated attributes
996
+
997
+ ### createRepository
998
+
999
+ Create a repository.
1000
+
1001
+ #### Parameters
1002
+
1003
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of group and repository
1004
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1005
+
1006
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**&#x20;
1007
+
1008
+ ### list
1009
+
1010
+ List provider objects of a given type.
1011
+
1012
+ #### Parameters
1013
+
1014
+ * `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
1015
+ * `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
1016
+
1017
+ ### projects
1018
+
1019
+ List projects.
1020
+
1021
+ #### Parameters
1022
+
1023
+ * `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))?**&#x20;
1024
+
1025
+ Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
1026
+
1027
+ ### milestones
1028
+
1029
+ List milestones.
1030
+
1031
+ #### Parameters
1032
+
1033
+ * `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))?**&#x20;
1034
+
1035
+ Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
1036
+
1037
+ ### repositories
1038
+
1039
+ List repositories.
1040
+
1041
+ #### Parameters
1042
+
1043
+ * `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))?**&#x20;
1044
+
1045
+ Returns **AsyncIterable<[Repository](#repository)>** all matching repos of the provider
1046
+
1047
+ ### branches
1048
+
1049
+ List branches.
1050
+
1051
+ #### Parameters
1052
+
1053
+ * `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))?**&#x20;
1054
+
1055
+ Returns **AsyncIterable<[Branch](#branch)>** all matching branches of the provider
1056
+
1057
+ ### tags
1058
+
1059
+ List tags.
1060
+
1061
+ #### Parameters
1062
+
1063
+ * `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))?**&#x20;
1064
+
1065
+ Returns **AsyncIterable<[Tag](#tag)>** all matching tags of the provider
1066
+
1067
+ ### hooks
1068
+
1069
+ List hooks.
1070
+
1071
+ #### Parameters
1072
+
1073
+ * `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))?**&#x20;
1074
+
1075
+ Returns **AsyncIterable<[Hook](#hook)>** all matching hooks of the provider
1076
+
1077
+ ### pullRequests
1078
+
1079
+ List pull requests.
1080
+
1081
+ #### Parameters
1082
+
1083
+ * `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))?**&#x20;
1084
+
1085
+ Returns **AsyncIterable<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
1086
+
1087
+ ### name
1088
+
1089
+ Deliver the provider name.
1090
+
1091
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** class name by default
1092
+
1093
+ ### provider
1094
+
1095
+ We are our own provider.
1096
+
1097
+ Returns **[BaseProvider](#baseprovider)** this
1098
+
1099
+ ### toJSON
1100
+
1101
+ List all defined entries from attributes.
1102
+ return {object}
1103
+
1104
+ ### repositoryGroupClass
1105
+
1106
+ ### hookClass
1107
+
1108
+ ### repositoryClass
1109
+
1110
+ ### branchClass
1111
+
1112
+ ### tagClass
1113
+
1114
+ ### entryClass
1115
+
1116
+ ### pullRequestClass
1117
+
1118
+ ### instanceIdentifier
1119
+
1120
+ Prefix used to form environment variables.
1121
+ 'GITHUB\_' -> 'GITHUB\_TOKEN'
1122
+
1123
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** identifier for environment options
1124
+
1125
+ ### optionsFromEnvironment
1126
+
1127
+ Extract options suitable for the constructor.
1128
+ Form the given set of environment variables.
1129
+ Object with the detected key value pairs is delivered.
1130
+
1131
+ #### Parameters
1132
+
1133
+ * `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** as from process.env
1134
+ * `instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** part of variable name. (optional, default `this.instanceIdentifier`)
1135
+
1136
+ 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
1137
+
1138
+ ### areOptionsSufficcient
1139
+
1140
+ Check if given options are sufficient to create a provider.
1141
+
1142
+ #### Parameters
1143
+
1144
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1145
+
1146
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if options ar sufficient to construct a provider
1147
+
1148
+ ### initialize
1149
+
1150
+ Creates a new provider for a given set of options.
1151
+
1152
+ #### Parameters
1153
+
1154
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options (optional, default `{}`)
1155
+
1156
+ * `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
1157
+ * `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
1158
+
1159
+ 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
1160
+
1161
+ ## MessageDestination
1162
+
1163
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1164
+
1165
+ ### Properties
1166
+
1167
+ * `info` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
1168
+ * `debug` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
1169
+ * `warn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
1170
+ * `error` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
1171
+ * `trace` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
1172
+
1173
+ ## name
1174
+
1175
+ Name of the provider.
1176
+
1177
+ ## messageDestination
1178
+
1179
+ To forward info/warn and error messages to
1180
+
1181
+ ## Branch
1182
+
1183
+ * **See**: [Repository#\_addBranch](Repository#_addBranch)
1184
+
1185
+ Abstract branch.
1186
+
1187
+ ### Parameters
1188
+
1189
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1190
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1191
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1192
+
1193
+ ### Properties
1194
+
1195
+ * `repository` **[Repository](#repository)**&#x20;
1196
+ * `provider` **Provider**&#x20;
1197
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1198
+
1199
+ ### url
1200
+
1201
+ Deliver repository and branch url combined.
1202
+
1203
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repoUrl#branch'
1204
+
1205
+ ### refType
1206
+
1207
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** heades
1208
+
1209
+ ### isWritable
1210
+
1211
+ Returns **any** true if not [isArchived](isArchived) and [isDisabled](isDisabled) and [isLocked](isLocked) and [isProtected](#isprotected)
1212
+
1213
+ ### isDefault
1214
+
1215
+ Are we the default branch.
1216
+
1217
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name matches the repository default branch
1218
+
1219
+ ### delete
1220
+
1221
+ * **See**: [Repository#deleteBranch](#repositorydeletebranch)
1222
+
1223
+ Delete the branch from the [Repository](#repository).
1224
+
1225
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
1226
+
1227
+ ### commit
1228
+
1229
+ Commit entries.
1230
+
1231
+ #### Parameters
875
1232
 
876
1233
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
877
1234
  * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
878
1235
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
879
1236
 
880
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>**&#x20;
1237
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([CommitResult](#commitresult) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>**&#x20;
881
1238
 
882
1239
  ### commitIntoPullRequest
883
1240
 
@@ -906,181 +1263,406 @@ Remove entries form the branch.
906
1263
 
907
1264
  ### createPullRequest
908
1265
 
909
- Create a pull request.
1266
+ Create a pull request.
1267
+
1268
+ #### Parameters
1269
+
1270
+ * `toBranch` **[Branch](#branch)**&#x20;
1271
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1272
+
1273
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**&#x20;
1274
+
1275
+ ### createBranch
1276
+
1277
+ Create a new [Branch](#branch) by cloning a given source branch.
1278
+ Simply calls Repository.createBranch() with the receiver as source branch
1279
+
1280
+ #### Parameters
1281
+
1282
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the new branch
1283
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** passed through
1284
+
1285
+ 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)
1286
+
1287
+ ## CommitResult
1288
+
1289
+ ### Parameters
1290
+
1291
+ * `ref` &#x20;
1292
+
1293
+ ### Properties
1294
+
1295
+ * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1296
+
1297
+ ## Commit
1298
+
1299
+ ### Parameters
1300
+
1301
+ * `repository` &#x20;
1302
+
1303
+ ### Properties
1304
+
1305
+ * `repository` **[Repository](#repository)**&#x20;
1306
+ * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1307
+ * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1308
+ * `author` **User**&#x20;
1309
+ * `committer` **User**&#x20;
1310
+
1311
+ ## Hook
1312
+
1313
+ **Extends OwnedObject**
1314
+
1315
+ Repository hook.
1316
+
1317
+ ## Issue
1318
+
1319
+ **Extends OwnedObject**
1320
+
1321
+ ## Milestone
1322
+
1323
+ **Extends OwnedObject**
1324
+
1325
+ ## MultiGroupProvider
1326
+
1327
+ **Extends BaseProvider**
1328
+
1329
+ Provider supporting serveral repository groups.
1330
+
1331
+ ### repository
1332
+
1333
+ Lookup a repository in the provider and all of its repository groups.
1334
+
1335
+ #### Parameters
1336
+
1337
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1338
+
1339
+ 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))>**&#x20;
1340
+
1341
+ ### branch
1342
+
1343
+ Lookup a branch.
1344
+
1345
+ #### Parameters
1346
+
1347
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
1348
+
1349
+ 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))>**&#x20;
1350
+
1351
+ ### repositoryGroup
1352
+
1353
+ Lookup a repository group.
1354
+
1355
+ #### Parameters
1356
+
1357
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1358
+
1359
+ 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))>**&#x20;
1360
+
1361
+ ### repositoryGroups
1362
+
1363
+ List groups.
1364
+
1365
+ #### Parameters
1366
+
1367
+ * `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))?**&#x20;
1368
+
1369
+ Returns **AsyncIterable<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
1370
+
1371
+ ### createRepositoryGroup
1372
+
1373
+ Create a new repository group.
1374
+ If there is already a group for the given name it will be returend instead
1375
+
1376
+ #### Parameters
1377
+
1378
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1379
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1380
+
1381
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**&#x20;
1382
+
1383
+ ### addRepositoryGroup
1384
+
1385
+ Add a new repository group (not provider specific actions are executed).
1386
+
1387
+ #### Parameters
1388
+
1389
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1390
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1391
+
1392
+ Returns **[RepositoryGroup](#repositorygroup)**&#x20;
1393
+
1394
+ ## NamedObject
1395
+
1396
+ **Extends BaseObject**
1397
+
1398
+ ### Parameters
1399
+
1400
+ * `name` &#x20;
1401
+ * `options` &#x20;
1402
+ * `additionalProperties` &#x20;
1403
+
1404
+ ### displayName
1405
+
1406
+ Beautified name use for human displaying only.
1407
+
1408
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
1409
+
1410
+ ### condensedName
1411
+
1412
+ Name with default parts removed
1413
+
1414
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1415
+
1416
+ ### fullCondensedName
1417
+
1418
+ Complete name in the hierachy.
1419
+
1420
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1421
+
1422
+ ### equals
1423
+
1424
+ Check for equality.
1425
+
1426
+ #### Parameters
1427
+
1428
+ * `other` **[NamedObject](#namedobject)**&#x20;
1429
+
1430
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if names are equal and have the same provider
1431
+
1432
+ ### toJSON
1433
+
1434
+ Provided name and all defined attributes.
1435
+
1436
+ ## NamedObject
1437
+
1438
+ **Extends BaseObject**
1439
+
1440
+ Object with a name.
1441
+
1442
+ ### Parameters
1443
+
1444
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1445
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1446
+ * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1447
+
1448
+ ### Properties
1449
+
1450
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1451
+
1452
+ ### displayName
1453
+
1454
+ Beautified name use for human displaying only.
1455
+
1456
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
1457
+
1458
+ ### condensedName
1459
+
1460
+ Name with default parts removed
1461
+
1462
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1463
+
1464
+ ### fullCondensedName
1465
+
1466
+ Complete name in the hierachy.
1467
+
1468
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1469
+
1470
+ ### equals
1471
+
1472
+ Check for equality.
1473
+
1474
+ #### Parameters
1475
+
1476
+ * `other` **[NamedObject](#namedobject)**&#x20;
1477
+
1478
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if names are equal and have the same provider
1479
+
1480
+ ### toJSON
1481
+
1482
+ Provided name and all defined attributes.
1483
+
1484
+ ## OwnedObject
1485
+
1486
+ **Extends NamedObject**
1487
+
1488
+ ### Parameters
1489
+
1490
+ * `owner` &#x20;
1491
+ * `name` &#x20;
1492
+ * `options` &#x20;
1493
+ * `additionalProperties` &#x20;
1494
+
1495
+ ### delete
1496
+
1497
+ Removes the receiver from the owner.
1498
+
1499
+ ### equals
1500
+
1501
+ Check for equality.
1502
+
1503
+ #### Parameters
1504
+
1505
+ * `other` **[OwnedObject](#ownedobject)**&#x20;
1506
+
1507
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if receiver and owner are equal
1508
+
1509
+ ### homePageURL
910
1510
 
911
- #### Parameters
1511
+ * **See**: [Repository#homePageURL](#repositoryhomepageurl)
912
1512
 
913
- * `toBranch` **[Branch](#branch)**&#x20;
914
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1513
+ Url of home page.
915
1514
 
916
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**&#x20;
1515
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** as provided from the owner
917
1516
 
918
- ### createBranch
1517
+ ### issuesURL
919
1518
 
920
- Create a new [Branch](#branch) by cloning a given source branch.
921
- Simply calls Repository.createBranch() with the receiver as source branch
1519
+ * **See**: [Repository#issuesURL](#repositoryissuesurl)
922
1520
 
923
- #### Parameters
1521
+ Url of issue tracking system.
924
1522
 
925
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the new branch
926
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** passed through
1523
+ 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))** as provided from the repository
927
1524
 
928
- 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)
1525
+ ### isLocked
929
1526
 
930
- ## CommitResult
1527
+ Forwarded from the owner.
931
1528
 
932
- ### Parameters
1529
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
933
1530
 
934
- * `ref` &#x20;
1531
+ ### isArchived
935
1532
 
936
- ### Properties
1533
+ Forwarded from the owner.
937
1534
 
938
- * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1535
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
939
1536
 
940
- ## Commit
1537
+ ### isDisabled
941
1538
 
942
- ### Parameters
1539
+ Forwarded from the owner.
943
1540
 
944
- * `repository` &#x20;
1541
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
945
1542
 
946
- ### Properties
1543
+ ### api
947
1544
 
948
- * `repository` **[Repository](#repository)**&#x20;
949
- * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
950
- * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
951
- * `author` **User**&#x20;
952
- * `committer` **User**&#x20;
1545
+ API as given by the owner.
953
1546
 
954
- ## Hook
1547
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
955
1548
 
956
- **Extends OwnedObject**
1549
+ ### slug
957
1550
 
958
- Repository hook.
1551
+ API as given by the owner.
959
1552
 
960
- ## Issue
1553
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
961
1554
 
962
- **Extends OwnedObject**
1555
+ ### url
963
1556
 
964
- ## Milestone
1557
+ URL as given by the owner.
965
1558
 
966
- **Extends OwnedObject**
1559
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
967
1560
 
968
- ## MultiGroupProvider
1561
+ ### provider
969
1562
 
970
- **Extends BaseProvider**
1563
+ The provider we live in.
971
1564
 
972
- Provider supporting serveral repository groups.
1565
+ Returns **[BaseProvider](#baseprovider)**&#x20;
973
1566
 
974
- ### repository
1567
+ ### identifier
975
1568
 
976
- Lookup a repository in the provider and all of its repository groups.
1569
+ Short human readable identifier with provider and branch.
977
1570
 
978
- #### Parameters
1571
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
979
1572
 
980
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1573
+ ### fullName
981
1574
 
982
- 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))>**&#x20;
1575
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name with owner name
983
1576
 
984
- ### branch
1577
+ ### trace
985
1578
 
986
- Lookup a branch.
1579
+ Forwarded to the owner.
987
1580
 
988
1581
  #### Parameters
989
1582
 
990
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
991
-
992
- 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))>**&#x20;
1583
+ * `args` **...any**&#x20;
993
1584
 
994
- ### repositoryGroup
1585
+ ### info
995
1586
 
996
- Lookup a repository group.
1587
+ Forwarded to the owner.
997
1588
 
998
1589
  #### Parameters
999
1590
 
1000
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1001
-
1002
- 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))>**&#x20;
1591
+ * `args` **...any**&#x20;
1003
1592
 
1004
- ### repositoryGroups
1593
+ ### warn
1005
1594
 
1006
- List groups.
1595
+ Forwarded to the owner.
1007
1596
 
1008
1597
  #### Parameters
1009
1598
 
1010
- * `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))?**&#x20;
1011
-
1012
- Returns **AsyncIterable<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
1599
+ * `args` **...any**&#x20;
1013
1600
 
1014
- ### createRepositoryGroup
1601
+ ### error
1015
1602
 
1016
- Create a new repository group.
1017
- If there is already a group for the given name it will be returend instead
1603
+ Forwarded to the owner.
1018
1604
 
1019
1605
  #### Parameters
1020
1606
 
1021
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1022
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1023
-
1024
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**&#x20;
1607
+ * `args` **...any**&#x20;
1025
1608
 
1026
- ### addRepositoryGroup
1609
+ ### debug
1027
1610
 
1028
- Add a new repository group (not provider specific actions are executed).
1611
+ Forwarded to the owner.
1029
1612
 
1030
1613
  #### Parameters
1031
1614
 
1032
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1033
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1615
+ * `args` **...any**&#x20;
1034
1616
 
1035
- Returns **[RepositoryGroup](#repositorygroup)**&#x20;
1617
+ ### repositoryClass
1036
1618
 
1037
- ## NamedObject
1619
+ By default we use the owners implementation.
1038
1620
 
1039
- **Extends BaseObject**
1621
+ Returns **[Repository](#repository)** as defined in the owner
1040
1622
 
1041
- Object with a name.
1623
+ ### pullRequestClass
1042
1624
 
1043
- ### Parameters
1625
+ By default we use the owners implementation.
1044
1626
 
1045
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1046
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1047
- * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
1627
+ Returns **[PullRequest](#pullrequest)** as defined in the owner
1048
1628
 
1049
- ### Properties
1629
+ ### branchClass
1050
1630
 
1051
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1631
+ By default we use the owners implementation.
1052
1632
 
1053
- ### displayName
1633
+ Returns **[Branch](#branch)** as defined in the owner
1054
1634
 
1055
- Beautified name use for human displaying only.
1635
+ ### tagClass
1056
1636
 
1057
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
1637
+ By default we use the owners implementation.
1058
1638
 
1059
- ### condensedName
1639
+ Returns **[Tag](#tag)** as defined in the owner
1060
1640
 
1061
- Name with default parts removed
1641
+ ### entryClass
1062
1642
 
1063
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1643
+ By default we use the owners implementation.
1064
1644
 
1065
- ### fullCondensedName
1645
+ Returns **ContentEntry** as defined in the owner
1066
1646
 
1067
- Complete name in the hierachy.
1647
+ ### hookClass
1068
1648
 
1069
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1649
+ By default we use the owners implementation.
1070
1650
 
1071
- ### equals
1651
+ Returns **[Hook](#hook)** as defined in the owner
1072
1652
 
1073
- Check for equality.
1653
+ ### addMethodName
1074
1654
 
1075
- #### Parameters
1655
+ Method name to be called to register one instance in the owner.
1656
+ sample: Application => \_addApplication
1076
1657
 
1077
- * `other` **[NamedObject](#namedobject)**&#x20;
1658
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1078
1659
 
1079
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if names are equal and have the same provider
1660
+ ### deleteMethodName
1080
1661
 
1081
- ### toJSON
1662
+ Method name to be called to unregister one instance in the owner.
1663
+ sample: Application => \_deleteApplication
1082
1664
 
1083
- Provided name and all defined attributes.
1665
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1084
1666
 
1085
1667
  ## OwnedObject
1086
1668
 
@@ -1123,7 +1705,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1123
1705
 
1124
1706
  Url of issue tracking system.
1125
1707
 
1126
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** as provided from the repository
1708
+ 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))** as provided from the repository
1127
1709
 
1128
1710
  ### isLocked
1129
1711
 
@@ -1425,6 +2007,94 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
1425
2007
 
1426
2008
  **Extends OwnedObject**
1427
2009
 
2010
+ ### ref
2011
+
2012
+ Full ref path.
2013
+
2014
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** git ref of the Ref
2015
+
2016
+ ### refId
2017
+
2018
+ Get sha of our ref.
2019
+
2020
+ 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
2021
+
2022
+ ### entries
2023
+
2024
+ List entries of the branch.
2025
+
2026
+ #### Parameters
2027
+
2028
+ * `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))?**&#x20;
2029
+
2030
+ Returns **AsyncGenerator\<ContentEntry>** all matching entries in the branch
2031
+
2032
+ ### asyncIterator
2033
+
2034
+ List all entries of the branch.
2035
+
2036
+ Returns **AsyncGenerator\<ContentEntry>** all entries in the branch
2037
+
2038
+ ### maybeEntry
2039
+
2040
+ Get exactly one matching entry by name or undefine if no such entry is found.
2041
+
2042
+ #### Parameters
2043
+
2044
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
2045
+
2046
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<(ContentEntry | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>**&#x20;
2047
+
2048
+ ### entry
2049
+
2050
+ Get exactly one matching entry by name (throws if entry is not found).
2051
+
2052
+ #### Parameters
2053
+
2054
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
2055
+
2056
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**&#x20;
2057
+
2058
+ ### repository
2059
+
2060
+ * **See**: [Repository#owner](Repository#owner)
2061
+
2062
+ Ref owner.
2063
+ By default we provide the repository owner
2064
+
2065
+ Returns **[Repository](#repository)**&#x20;
2066
+
2067
+ ### fullName
2068
+
2069
+ Repository and branch name combined.
2070
+
2071
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repo#branch'
2072
+
2073
+ ### fullCondensedName
2074
+
2075
+ Repository fullName and branch name combined.
2076
+ But skipping the branch name if it is the default branch.
2077
+
2078
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'user/repo#branch'
2079
+
2080
+ ### isProtected
2081
+
2082
+ Returns **any** false
2083
+
2084
+ ### isDefault
2085
+
2086
+ Are we the default ref.
2087
+
2088
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
2089
+
2090
+ ### attributes
2091
+
2092
+ options
2093
+
2094
+ ## Ref
2095
+
2096
+ **Extends OwnedObject**
2097
+
1428
2098
  Base for Branch and Tag
1429
2099
 
1430
2100
  ### ref