repository-provider 35.2.2 → 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.
- package/README.md +946 -272
- package/package.json +4 -4
- package/src/base-object.mjs +3 -1
- package/src/base-provider.mjs +18 -5
- package/src/branch.mjs +11 -2
- package/src/index.mjs +10 -0
- package/src/multi-group-provider.mjs +1 -0
- package/src/named-object.mjs +7 -0
- package/src/owned-object.mjs +12 -1
- package/src/pull-request.mjs +5 -0
- package/src/ref.mjs +6 -0
- package/src/repository-owner.mjs +2 -0
- package/src/repository.mjs +11 -2
- package/src/single-group-provider.mjs +2 -0
- package/types/base-provider.d.mts +9 -4
- package/types/branch.d.mts +3 -3
- package/types/named-object.d.mts +6 -0
- package/types/owned-object.d.mts +21 -7
- package/types/ref.d.mts +9 -1
- package/types/repository-group.d.mts +1 -1
- package/types/repository-owner.d.mts +1 -1
- package/types/single-group-provider.d.mts +1 -1
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
|
-
* [
|
|
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-
|
|
186
|
+
* [Parameters](#parameters-42)
|
|
138
187
|
* [Properties](#properties-3)
|
|
139
188
|
* [url](#url)
|
|
140
189
|
* [refType](#reftype)
|
|
@@ -142,50 +191,59 @@ console.log(await readme.string);
|
|
|
142
191
|
* [isDefault](#isdefault)
|
|
143
192
|
* [delete](#delete)
|
|
144
193
|
* [commit](#commit)
|
|
145
|
-
* [Parameters](#parameters-
|
|
194
|
+
* [Parameters](#parameters-43)
|
|
146
195
|
* [commitIntoPullRequest](#commitintopullrequest)
|
|
147
|
-
* [Parameters](#parameters-
|
|
196
|
+
* [Parameters](#parameters-44)
|
|
148
197
|
* [removeEntries](#removeentries)
|
|
149
|
-
* [Parameters](#parameters-
|
|
198
|
+
* [Parameters](#parameters-45)
|
|
150
199
|
* [createPullRequest](#createpullrequest)
|
|
151
|
-
* [Parameters](#parameters-
|
|
200
|
+
* [Parameters](#parameters-46)
|
|
152
201
|
* [createBranch](#createbranch)
|
|
153
|
-
* [Parameters](#parameters-
|
|
202
|
+
* [Parameters](#parameters-47)
|
|
154
203
|
* [CommitResult](#commitresult)
|
|
204
|
+
* [Parameters](#parameters-48)
|
|
155
205
|
* [Properties](#properties-4)
|
|
156
206
|
* [Commit](#commit-1)
|
|
157
|
-
* [Parameters](#parameters-
|
|
207
|
+
* [Parameters](#parameters-49)
|
|
158
208
|
* [Properties](#properties-5)
|
|
159
209
|
* [Hook](#hook)
|
|
160
210
|
* [Issue](#issue)
|
|
161
211
|
* [Milestone](#milestone)
|
|
162
212
|
* [MultiGroupProvider](#multigroupprovider)
|
|
163
213
|
* [repository](#repository)
|
|
164
|
-
* [Parameters](#parameters-
|
|
214
|
+
* [Parameters](#parameters-50)
|
|
165
215
|
* [branch](#branch-1)
|
|
166
|
-
* [Parameters](#parameters-
|
|
216
|
+
* [Parameters](#parameters-51)
|
|
167
217
|
* [repositoryGroup](#repositorygroup)
|
|
168
|
-
* [Parameters](#parameters-
|
|
218
|
+
* [Parameters](#parameters-52)
|
|
169
219
|
* [repositoryGroups](#repositorygroups)
|
|
170
|
-
* [Parameters](#parameters-
|
|
220
|
+
* [Parameters](#parameters-53)
|
|
171
221
|
* [createRepositoryGroup](#createrepositorygroup)
|
|
172
|
-
* [Parameters](#parameters-
|
|
222
|
+
* [Parameters](#parameters-54)
|
|
173
223
|
* [addRepositoryGroup](#addrepositorygroup)
|
|
174
|
-
* [Parameters](#parameters-
|
|
224
|
+
* [Parameters](#parameters-55)
|
|
175
225
|
* [NamedObject](#namedobject)
|
|
176
|
-
* [Parameters](#parameters-
|
|
177
|
-
* [Properties](#properties-6)
|
|
226
|
+
* [Parameters](#parameters-56)
|
|
178
227
|
* [displayName](#displayname)
|
|
179
228
|
* [condensedName](#condensedname)
|
|
180
229
|
* [fullCondensedName](#fullcondensedname)
|
|
181
|
-
* [equals](#equals-
|
|
182
|
-
* [Parameters](#parameters-
|
|
183
|
-
* [toJSON](#tojson-
|
|
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)
|
|
184
242
|
* [OwnedObject](#ownedobject)
|
|
185
|
-
* [Parameters](#parameters-
|
|
243
|
+
* [Parameters](#parameters-60)
|
|
186
244
|
* [delete](#delete-1)
|
|
187
|
-
* [equals](#equals-
|
|
188
|
-
* [Parameters](#parameters-
|
|
245
|
+
* [equals](#equals-5)
|
|
246
|
+
* [Parameters](#parameters-61)
|
|
189
247
|
* [homePageURL](#homepageurl)
|
|
190
248
|
* [issuesURL](#issuesurl)
|
|
191
249
|
* [isLocked](#islocked)
|
|
@@ -194,164 +252,215 @@ console.log(await readme.string);
|
|
|
194
252
|
* [api](#api)
|
|
195
253
|
* [slug](#slug)
|
|
196
254
|
* [url](#url-1)
|
|
197
|
-
* [provider](#provider-
|
|
255
|
+
* [provider](#provider-2)
|
|
198
256
|
* [identifier](#identifier)
|
|
199
257
|
* [fullName](#fullname-1)
|
|
200
258
|
* [trace](#trace)
|
|
201
|
-
* [Parameters](#parameters-
|
|
259
|
+
* [Parameters](#parameters-62)
|
|
202
260
|
* [info](#info)
|
|
203
|
-
* [Parameters](#parameters-
|
|
261
|
+
* [Parameters](#parameters-63)
|
|
204
262
|
* [warn](#warn)
|
|
205
|
-
* [Parameters](#parameters-
|
|
263
|
+
* [Parameters](#parameters-64)
|
|
206
264
|
* [error](#error)
|
|
207
|
-
* [Parameters](#parameters-
|
|
265
|
+
* [Parameters](#parameters-65)
|
|
208
266
|
* [debug](#debug)
|
|
209
|
-
* [Parameters](#parameters-
|
|
210
|
-
* [repositoryClass](#repositoryclass-
|
|
211
|
-
* [pullRequestClass](#pullrequestclass-
|
|
212
|
-
* [branchClass](#branchclass-
|
|
213
|
-
* [tagClass](#tagclass-
|
|
214
|
-
* [entryClass](#entryclass-
|
|
215
|
-
* [hookClass](#hookclass-
|
|
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)
|
|
216
274
|
* [addMethodName](#addmethodname)
|
|
217
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)
|
|
218
310
|
* [Project](#project)
|
|
219
311
|
* [PullRequest](#pullrequest)
|
|
220
|
-
* [Parameters](#parameters-
|
|
312
|
+
* [Parameters](#parameters-74)
|
|
221
313
|
* [Properties](#properties-7)
|
|
222
|
-
* [fullName](#fullname-
|
|
223
|
-
* [url](#url-
|
|
314
|
+
* [fullName](#fullname-3)
|
|
315
|
+
* [url](#url-3)
|
|
224
316
|
* [repository](#repository-1)
|
|
225
|
-
* [delete](#delete-
|
|
317
|
+
* [delete](#delete-3)
|
|
226
318
|
* [merge](#merge)
|
|
227
|
-
* [Parameters](#parameters-
|
|
319
|
+
* [Parameters](#parameters-75)
|
|
228
320
|
* [decline](#decline)
|
|
229
321
|
* [reviews](#reviews)
|
|
230
|
-
* [identifier](#identifier-
|
|
322
|
+
* [identifier](#identifier-2)
|
|
231
323
|
* [defaultListStates](#defaultliststates)
|
|
232
324
|
* [states](#states)
|
|
233
325
|
* [validMergeMethods](#validmergemethods)
|
|
234
|
-
* [list](#list-
|
|
235
|
-
* [Parameters](#parameters-
|
|
326
|
+
* [list](#list-2)
|
|
327
|
+
* [Parameters](#parameters-76)
|
|
236
328
|
* [open](#open)
|
|
237
|
-
* [Parameters](#parameters-
|
|
329
|
+
* [Parameters](#parameters-77)
|
|
238
330
|
* [state](#state)
|
|
239
331
|
* [locked](#locked)
|
|
240
332
|
* [merged](#merged)
|
|
241
333
|
* [draft](#draft)
|
|
242
|
-
* [ContentEntry](#contententry)
|
|
243
|
-
* [Properties](#properties-8)
|
|
244
334
|
* [Ref](#ref)
|
|
245
335
|
* [ref](#ref-1)
|
|
246
336
|
* [refId](#refid)
|
|
247
337
|
* [entries](#entries)
|
|
248
|
-
* [Parameters](#parameters-
|
|
338
|
+
* [Parameters](#parameters-78)
|
|
249
339
|
* [asyncIterator](#asynciterator)
|
|
250
340
|
* [maybeEntry](#maybeentry)
|
|
251
|
-
* [Parameters](#parameters-
|
|
341
|
+
* [Parameters](#parameters-79)
|
|
252
342
|
* [entry](#entry)
|
|
253
|
-
* [Parameters](#parameters-
|
|
343
|
+
* [Parameters](#parameters-80)
|
|
254
344
|
* [repository](#repository-2)
|
|
255
|
-
* [fullName](#fullname-
|
|
256
|
-
* [fullCondensedName](#fullcondensedname-
|
|
345
|
+
* [fullName](#fullname-4)
|
|
346
|
+
* [fullCondensedName](#fullcondensedname-2)
|
|
257
347
|
* [isProtected](#isprotected)
|
|
258
348
|
* [isDefault](#isdefault-1)
|
|
259
349
|
* [attributes](#attributes-1)
|
|
260
|
-
* [
|
|
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)
|
|
261
367
|
* [RepositoryGroup](#repositorygroup-1)
|
|
262
|
-
* [Parameters](#parameters-
|
|
263
|
-
* [Properties](#properties-
|
|
368
|
+
* [Parameters](#parameters-84)
|
|
369
|
+
* [Properties](#properties-8)
|
|
264
370
|
* [attributeMapping](#attributemapping-1)
|
|
265
371
|
* [type](#type-1)
|
|
266
|
-
* [homePageURL](#homepageurl-
|
|
372
|
+
* [homePageURL](#homepageurl-2)
|
|
267
373
|
* [RepositoryOwner](#repositoryowner)
|
|
268
|
-
* [Parameters](#parameters-
|
|
269
|
-
* [Repository](#repository-
|
|
270
|
-
* [Parameters](#parameters-
|
|
271
|
-
* [Properties](#properties-
|
|
272
|
-
* [slug](#slug-
|
|
273
|
-
* [entry](#entry-
|
|
274
|
-
* [Parameters](#parameters-
|
|
275
|
-
* [entries](#entries-
|
|
276
|
-
* [Parameters](#parameters-
|
|
277
|
-
* [maybeEntry](#maybeentry-
|
|
278
|
-
* [Parameters](#parameters-
|
|
374
|
+
* [Parameters](#parameters-85)
|
|
375
|
+
* [Repository](#repository-4)
|
|
376
|
+
* [Parameters](#parameters-86)
|
|
377
|
+
* [Properties](#properties-9)
|
|
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)
|
|
279
385
|
* [commits](#commits)
|
|
280
|
-
* [Parameters](#parameters-
|
|
386
|
+
* [Parameters](#parameters-90)
|
|
281
387
|
* [cloneURL](#cloneurl)
|
|
282
|
-
* [issuesURL](#issuesurl-
|
|
283
|
-
* [homePageURL](#homepageurl-
|
|
284
|
-
* [isArchived](#isarchived-
|
|
285
|
-
* [isLocked](#islocked-
|
|
286
|
-
* [isDisabled](#isdisabled-
|
|
388
|
+
* [issuesURL](#issuesurl-2)
|
|
389
|
+
* [homePageURL](#homepageurl-3)
|
|
390
|
+
* [isArchived](#isarchived-2)
|
|
391
|
+
* [isLocked](#islocked-2)
|
|
392
|
+
* [isDisabled](#isdisabled-2)
|
|
287
393
|
* [isTemplate](#istemplate)
|
|
288
|
-
* [delete](#delete-
|
|
394
|
+
* [delete](#delete-4)
|
|
289
395
|
* [defaultBranch](#defaultbranch)
|
|
290
396
|
* [branch](#branch-2)
|
|
291
|
-
* [Parameters](#parameters-
|
|
397
|
+
* [Parameters](#parameters-91)
|
|
292
398
|
* [hasBranches](#hasbranches)
|
|
293
|
-
* [branches](#branches-
|
|
294
|
-
* [Parameters](#parameters-
|
|
399
|
+
* [branches](#branches-2)
|
|
400
|
+
* [Parameters](#parameters-92)
|
|
295
401
|
* [createBranch](#createbranch-1)
|
|
296
|
-
* [Parameters](#parameters-
|
|
402
|
+
* [Parameters](#parameters-93)
|
|
297
403
|
* [addBranch](#addbranch)
|
|
298
|
-
* [Parameters](#parameters-
|
|
404
|
+
* [Parameters](#parameters-94)
|
|
299
405
|
* [deleteBranch](#deletebranch)
|
|
300
|
-
* [Parameters](#parameters-
|
|
406
|
+
* [Parameters](#parameters-95)
|
|
301
407
|
* [tag](#tag)
|
|
302
|
-
* [Parameters](#parameters-
|
|
303
|
-
* [tags](#tags-
|
|
304
|
-
* [Parameters](#parameters-
|
|
408
|
+
* [Parameters](#parameters-96)
|
|
409
|
+
* [tags](#tags-2)
|
|
410
|
+
* [Parameters](#parameters-97)
|
|
305
411
|
* [addTag](#addtag)
|
|
306
|
-
* [Parameters](#parameters-
|
|
412
|
+
* [Parameters](#parameters-98)
|
|
307
413
|
* [createPullRequest](#createpullrequest-1)
|
|
308
|
-
* [Parameters](#parameters-
|
|
414
|
+
* [Parameters](#parameters-99)
|
|
309
415
|
* [addPullRequest](#addpullrequest)
|
|
310
|
-
* [Parameters](#parameters-
|
|
311
|
-
* [pullRequests](#pullrequests-
|
|
416
|
+
* [Parameters](#parameters-100)
|
|
417
|
+
* [pullRequests](#pullrequests-2)
|
|
312
418
|
* [pullRequest](#pullrequest-1)
|
|
313
|
-
* [Parameters](#parameters-
|
|
419
|
+
* [Parameters](#parameters-101)
|
|
314
420
|
* [deletePullRequest](#deletepullrequest)
|
|
315
|
-
* [Parameters](#parameters-
|
|
421
|
+
* [Parameters](#parameters-102)
|
|
316
422
|
* [addHook](#addhook)
|
|
317
|
-
* [Parameters](#parameters-
|
|
423
|
+
* [Parameters](#parameters-103)
|
|
318
424
|
* [createHook](#createhook)
|
|
319
|
-
* [Parameters](#parameters-
|
|
320
|
-
* [hooks](#hooks-
|
|
425
|
+
* [Parameters](#parameters-104)
|
|
426
|
+
* [hooks](#hooks-2)
|
|
321
427
|
* [hook](#hook-1)
|
|
322
|
-
* [Parameters](#parameters-
|
|
428
|
+
* [Parameters](#parameters-105)
|
|
323
429
|
* [milestone](#milestone-1)
|
|
324
|
-
* [Parameters](#parameters-
|
|
430
|
+
* [Parameters](#parameters-106)
|
|
325
431
|
* [project](#project-1)
|
|
326
|
-
* [Parameters](#parameters-
|
|
432
|
+
* [Parameters](#parameters-107)
|
|
327
433
|
* [application](#application-1)
|
|
328
|
-
* [Parameters](#parameters-
|
|
434
|
+
* [Parameters](#parameters-108)
|
|
329
435
|
* [type](#type-2)
|
|
330
|
-
* [refId](#refid-
|
|
331
|
-
* [Parameters](#parameters-
|
|
332
|
-
* [attributes](#attributes-
|
|
436
|
+
* [refId](#refid-2)
|
|
437
|
+
* [Parameters](#parameters-109)
|
|
438
|
+
* [attributes](#attributes-3)
|
|
333
439
|
* [defaultBranchName](#defaultbranchname)
|
|
334
|
-
* [branches](#branches-
|
|
335
|
-
* [tags](#tags-
|
|
336
|
-
* [
|
|
440
|
+
* [branches](#branches-3)
|
|
441
|
+
* [tags](#tags-3)
|
|
442
|
+
* [projects](#projects-2)
|
|
443
|
+
* [applications](#applications)
|
|
444
|
+
* [milestones](#milestones-2)
|
|
445
|
+
* [pullRequests](#pullrequests-3)
|
|
337
446
|
* [Review](#review)
|
|
338
447
|
* [SingleGroupProvider](#singlegroupprovider)
|
|
339
|
-
* [repository](#repository-
|
|
340
|
-
* [Parameters](#parameters-
|
|
448
|
+
* [repository](#repository-5)
|
|
449
|
+
* [Parameters](#parameters-110)
|
|
341
450
|
* [repositoryGroup](#repositorygroup-2)
|
|
342
|
-
* [Parameters](#parameters-
|
|
451
|
+
* [Parameters](#parameters-111)
|
|
343
452
|
* [repositoryGroups](#repositorygroups-1)
|
|
344
|
-
* [Parameters](#parameters-
|
|
453
|
+
* [Parameters](#parameters-112)
|
|
345
454
|
* [Tag](#tag-1)
|
|
346
455
|
* [refType](#reftype-1)
|
|
347
456
|
* [asArray](#asarray)
|
|
348
|
-
* [Parameters](#parameters-
|
|
457
|
+
* [Parameters](#parameters-113)
|
|
349
458
|
* [stripBaseName](#stripbasename)
|
|
350
|
-
* [Parameters](#parameters-
|
|
459
|
+
* [Parameters](#parameters-114)
|
|
351
460
|
* [stripBaseNames](#stripbasenames)
|
|
352
|
-
* [Parameters](#parameters-
|
|
461
|
+
* [Parameters](#parameters-115)
|
|
353
462
|
* [generateBranchName](#generatebranchname)
|
|
354
|
-
* [Parameters](#parameters-
|
|
463
|
+
* [Parameters](#parameters-116)
|
|
355
464
|
|
|
356
465
|
## Application
|
|
357
466
|
|
|
@@ -545,26 +654,10 @@ Map attributes between external and internal representation.
|
|
|
545
654
|
|
|
546
655
|
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
547
656
|
|
|
548
|
-
## MessageDestination
|
|
549
|
-
|
|
550
|
-
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
|
551
|
-
|
|
552
|
-
### Properties
|
|
553
|
-
|
|
554
|
-
* `info` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
555
|
-
* `debug` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
556
|
-
* `warn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
557
|
-
* `error` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
558
|
-
* `trace` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
559
|
-
|
|
560
657
|
## BaseProvider
|
|
561
658
|
|
|
562
659
|
**Extends BaseObject**
|
|
563
660
|
|
|
564
|
-
### Properties
|
|
565
|
-
|
|
566
|
-
* `messageDestination` **[MessageDestination](#messagedestination)** 
|
|
567
|
-
|
|
568
661
|
### equals
|
|
569
662
|
|
|
570
663
|
#### Parameters
|
|
@@ -811,73 +904,337 @@ Creates a new provider for a given set of options.
|
|
|
811
904
|
|
|
812
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
|
|
813
906
|
|
|
814
|
-
##
|
|
907
|
+
## BaseProvider
|
|
815
908
|
|
|
816
|
-
|
|
909
|
+
**Extends BaseObject**
|
|
817
910
|
|
|
818
|
-
|
|
911
|
+
### Properties
|
|
819
912
|
|
|
820
|
-
|
|
913
|
+
* `messageDestination` **[MessageDestination](#messagedestination)** 
|
|
821
914
|
|
|
822
|
-
|
|
915
|
+
### equals
|
|
823
916
|
|
|
824
|
-
|
|
917
|
+
#### Parameters
|
|
825
918
|
|
|
826
|
-
|
|
919
|
+
* `other` **any** 
|
|
827
920
|
|
|
828
|
-
|
|
921
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other provider is the same as the receiver
|
|
829
922
|
|
|
830
|
-
|
|
831
|
-
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
832
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
923
|
+
### repositoryBases
|
|
833
924
|
|
|
834
|
-
|
|
925
|
+
All supported base urls.
|
|
926
|
+
For github something like:
|
|
835
927
|
|
|
836
|
-
*
|
|
837
|
-
|
|
838
|
-
*
|
|
839
|
-
*
|
|
840
|
-
*
|
|
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
|
-
|
|
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
|
-
|
|
937
|
+
### supportsBase
|
|
845
938
|
|
|
846
|
-
|
|
939
|
+
Does the provider support the base name.
|
|
847
940
|
|
|
848
|
-
|
|
941
|
+
#### Parameters
|
|
849
942
|
|
|
850
|
-
|
|
943
|
+
* `base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** to be checked
|
|
851
944
|
|
|
852
|
-
|
|
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
|
-
|
|
947
|
+
### normalizeRepositoryName
|
|
855
948
|
|
|
856
|
-
|
|
949
|
+
Bring a repository name into its normal form by removing any clutter.
|
|
950
|
+
Like .git suffix or #branch names.
|
|
857
951
|
|
|
858
|
-
|
|
952
|
+
#### Parameters
|
|
859
953
|
|
|
860
|
-
|
|
954
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
955
|
+
* `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
861
956
|
|
|
862
|
-
|
|
957
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized name
|
|
863
958
|
|
|
864
|
-
|
|
959
|
+
### normalizeGroupName
|
|
865
960
|
|
|
866
|
-
|
|
961
|
+
Bring a group name into its normal form by removing any clutter.
|
|
962
|
+
Like .git suffix or #branch names.
|
|
867
963
|
|
|
868
|
-
|
|
964
|
+
#### Parameters
|
|
869
965
|
|
|
870
|
-
|
|
966
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
967
|
+
* `forLookup` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
871
968
|
|
|
872
|
-
|
|
969
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** normalized name
|
|
873
970
|
|
|
874
|
-
|
|
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)?** 
|
|
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)?** 
|
|
1005
|
+
|
|
1006
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>** 
|
|
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))?** 
|
|
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))?** 
|
|
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))?** 
|
|
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))?** 
|
|
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))?** 
|
|
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))?** 
|
|
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))?** 
|
|
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)** 
|
|
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)** 
|
|
1168
|
+
* `debug` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
1169
|
+
* `warn` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
1170
|
+
* `error` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
1171
|
+
* `trace` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** 
|
|
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)** 
|
|
1190
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1191
|
+
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
|
|
1192
|
+
|
|
1193
|
+
### Properties
|
|
1194
|
+
|
|
1195
|
+
* `repository` **[Repository](#repository)** 
|
|
1196
|
+
* `provider` **Provider** 
|
|
1197
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
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>** 
|
|
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
|
-
* `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)
|
|
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)** 
|
|
879
1236
|
|
|
880
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>** 
|
|
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))>** 
|
|
881
1238
|
|
|
882
1239
|
### commitIntoPullRequest
|
|
883
1240
|
|
|
@@ -902,183 +1259,410 @@ Remove entries form the branch.
|
|
|
902
1259
|
|
|
903
1260
|
#### Parameters
|
|
904
1261
|
|
|
905
|
-
* `entries` **AsyncIterable
|
|
1262
|
+
* `entries` **AsyncIterable\<ContentEntry>** 
|
|
1263
|
+
|
|
1264
|
+
### createPullRequest
|
|
1265
|
+
|
|
1266
|
+
Create a pull request.
|
|
1267
|
+
|
|
1268
|
+
#### Parameters
|
|
1269
|
+
|
|
1270
|
+
* `toBranch` **[Branch](#branch)** 
|
|
1271
|
+
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1272
|
+
|
|
1273
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>** 
|
|
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`  
|
|
1292
|
+
|
|
1293
|
+
### Properties
|
|
1294
|
+
|
|
1295
|
+
* `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1296
|
+
|
|
1297
|
+
## Commit
|
|
1298
|
+
|
|
1299
|
+
### Parameters
|
|
1300
|
+
|
|
1301
|
+
* `repository`  
|
|
1302
|
+
|
|
1303
|
+
### Properties
|
|
1304
|
+
|
|
1305
|
+
* `repository` **[Repository](#repository)** 
|
|
1306
|
+
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1307
|
+
* `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1308
|
+
* `author` **User** 
|
|
1309
|
+
* `committer` **User** 
|
|
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))>** 
|
|
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))>** 
|
|
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))>** 
|
|
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))?** 
|
|
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)?** 
|
|
1380
|
+
|
|
1381
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** 
|
|
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)?** 
|
|
1391
|
+
|
|
1392
|
+
Returns **[RepositoryGroup](#repositorygroup)** 
|
|
1393
|
+
|
|
1394
|
+
## NamedObject
|
|
1395
|
+
|
|
1396
|
+
**Extends BaseObject**
|
|
1397
|
+
|
|
1398
|
+
### Parameters
|
|
1399
|
+
|
|
1400
|
+
* `name`  
|
|
1401
|
+
* `options`  
|
|
1402
|
+
* `additionalProperties`  
|
|
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)** 
|
|
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)** 
|
|
1421
|
+
|
|
1422
|
+
### equals
|
|
1423
|
+
|
|
1424
|
+
Check for equality.
|
|
1425
|
+
|
|
1426
|
+
#### Parameters
|
|
1427
|
+
|
|
1428
|
+
* `other` **[NamedObject](#namedobject)** 
|
|
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)** 
|
|
1445
|
+
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1446
|
+
* `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1447
|
+
|
|
1448
|
+
### Properties
|
|
1449
|
+
|
|
1450
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
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)** 
|
|
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)** 
|
|
1469
|
+
|
|
1470
|
+
### equals
|
|
1471
|
+
|
|
1472
|
+
Check for equality.
|
|
1473
|
+
|
|
1474
|
+
#### Parameters
|
|
1475
|
+
|
|
1476
|
+
* `other` **[NamedObject](#namedobject)** 
|
|
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`  
|
|
1491
|
+
* `name`  
|
|
1492
|
+
* `options`  
|
|
1493
|
+
* `additionalProperties`  
|
|
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)** 
|
|
1506
|
+
|
|
1507
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if receiver and owner are equal
|
|
906
1508
|
|
|
907
|
-
###
|
|
1509
|
+
### homePageURL
|
|
908
1510
|
|
|
909
|
-
|
|
1511
|
+
* **See**: [Repository#homePageURL](#repositoryhomepageurl)
|
|
910
1512
|
|
|
911
|
-
|
|
1513
|
+
Url of home page.
|
|
912
1514
|
|
|
913
|
-
|
|
914
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1515
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** as provided from the owner
|
|
915
1516
|
|
|
916
|
-
|
|
1517
|
+
### issuesURL
|
|
917
1518
|
|
|
918
|
-
|
|
1519
|
+
* **See**: [Repository#issuesURL](#repositoryissuesurl)
|
|
919
1520
|
|
|
920
|
-
|
|
921
|
-
Simply calls Repository.createBranch() with the receiver as source branch
|
|
1521
|
+
Url of issue tracking system.
|
|
922
1522
|
|
|
923
|
-
|
|
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
|
|
924
1524
|
|
|
925
|
-
|
|
926
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** passed through
|
|
1525
|
+
### isLocked
|
|
927
1526
|
|
|
928
|
-
|
|
1527
|
+
Forwarded from the owner.
|
|
929
1528
|
|
|
930
|
-
|
|
1529
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
931
1530
|
|
|
932
|
-
|
|
1531
|
+
### isArchived
|
|
933
1532
|
|
|
934
|
-
|
|
1533
|
+
Forwarded from the owner.
|
|
935
1534
|
|
|
936
|
-
|
|
1535
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
937
1536
|
|
|
938
|
-
|
|
1537
|
+
### isDisabled
|
|
939
1538
|
|
|
940
|
-
|
|
1539
|
+
Forwarded from the owner.
|
|
941
1540
|
|
|
942
|
-
|
|
1541
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
943
1542
|
|
|
944
|
-
###
|
|
1543
|
+
### api
|
|
945
1544
|
|
|
946
|
-
|
|
947
|
-
* `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
948
|
-
* `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
949
|
-
* `author` **User** 
|
|
950
|
-
* `committer` **User** 
|
|
1545
|
+
API as given by the owner.
|
|
951
1546
|
|
|
952
|
-
|
|
1547
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
|
|
953
1548
|
|
|
954
|
-
|
|
1549
|
+
### slug
|
|
955
1550
|
|
|
956
|
-
|
|
1551
|
+
API as given by the owner.
|
|
957
1552
|
|
|
958
|
-
|
|
1553
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
|
|
959
1554
|
|
|
960
|
-
|
|
1555
|
+
### url
|
|
961
1556
|
|
|
962
|
-
|
|
1557
|
+
URL as given by the owner.
|
|
963
1558
|
|
|
964
|
-
**
|
|
1559
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** url
|
|
965
1560
|
|
|
966
|
-
|
|
1561
|
+
### provider
|
|
967
1562
|
|
|
968
|
-
|
|
1563
|
+
The provider we live in.
|
|
969
1564
|
|
|
970
|
-
|
|
1565
|
+
Returns **[BaseProvider](#baseprovider)** 
|
|
971
1566
|
|
|
972
|
-
###
|
|
1567
|
+
### identifier
|
|
973
1568
|
|
|
974
|
-
|
|
1569
|
+
Short human readable identifier with provider and branch.
|
|
975
1570
|
|
|
976
|
-
|
|
1571
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
977
1572
|
|
|
978
|
-
|
|
1573
|
+
### fullName
|
|
979
1574
|
|
|
980
|
-
Returns **[
|
|
1575
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name with owner name
|
|
981
1576
|
|
|
982
|
-
###
|
|
1577
|
+
### trace
|
|
983
1578
|
|
|
984
|
-
|
|
1579
|
+
Forwarded to the owner.
|
|
985
1580
|
|
|
986
1581
|
#### Parameters
|
|
987
1582
|
|
|
988
|
-
* `
|
|
989
|
-
|
|
990
|
-
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))>** 
|
|
1583
|
+
* `args` **...any** 
|
|
991
1584
|
|
|
992
|
-
###
|
|
1585
|
+
### info
|
|
993
1586
|
|
|
994
|
-
|
|
1587
|
+
Forwarded to the owner.
|
|
995
1588
|
|
|
996
1589
|
#### Parameters
|
|
997
1590
|
|
|
998
|
-
* `
|
|
999
|
-
|
|
1000
|
-
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))>** 
|
|
1591
|
+
* `args` **...any** 
|
|
1001
1592
|
|
|
1002
|
-
###
|
|
1593
|
+
### warn
|
|
1003
1594
|
|
|
1004
|
-
|
|
1595
|
+
Forwarded to the owner.
|
|
1005
1596
|
|
|
1006
1597
|
#### Parameters
|
|
1007
1598
|
|
|
1008
|
-
* `
|
|
1009
|
-
|
|
1010
|
-
Returns **AsyncIterable<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
|
|
1599
|
+
* `args` **...any** 
|
|
1011
1600
|
|
|
1012
|
-
###
|
|
1601
|
+
### error
|
|
1013
1602
|
|
|
1014
|
-
|
|
1015
|
-
If there is already a group for the given name it will be returend instead
|
|
1603
|
+
Forwarded to the owner.
|
|
1016
1604
|
|
|
1017
1605
|
#### Parameters
|
|
1018
1606
|
|
|
1019
|
-
* `
|
|
1020
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1021
|
-
|
|
1022
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** 
|
|
1607
|
+
* `args` **...any** 
|
|
1023
1608
|
|
|
1024
|
-
###
|
|
1609
|
+
### debug
|
|
1025
1610
|
|
|
1026
|
-
|
|
1611
|
+
Forwarded to the owner.
|
|
1027
1612
|
|
|
1028
1613
|
#### Parameters
|
|
1029
1614
|
|
|
1030
|
-
* `
|
|
1031
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1615
|
+
* `args` **...any** 
|
|
1032
1616
|
|
|
1033
|
-
|
|
1617
|
+
### repositoryClass
|
|
1034
1618
|
|
|
1035
|
-
|
|
1619
|
+
By default we use the owners implementation.
|
|
1036
1620
|
|
|
1037
|
-
**
|
|
1621
|
+
Returns **[Repository](#repository)** as defined in the owner
|
|
1038
1622
|
|
|
1039
|
-
|
|
1623
|
+
### pullRequestClass
|
|
1040
1624
|
|
|
1041
|
-
|
|
1625
|
+
By default we use the owners implementation.
|
|
1042
1626
|
|
|
1043
|
-
|
|
1044
|
-
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1045
|
-
* `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
|
|
1627
|
+
Returns **[PullRequest](#pullrequest)** as defined in the owner
|
|
1046
1628
|
|
|
1047
|
-
###
|
|
1629
|
+
### branchClass
|
|
1048
1630
|
|
|
1049
|
-
|
|
1631
|
+
By default we use the owners implementation.
|
|
1050
1632
|
|
|
1051
|
-
|
|
1633
|
+
Returns **[Branch](#branch)** as defined in the owner
|
|
1052
1634
|
|
|
1053
|
-
|
|
1635
|
+
### tagClass
|
|
1054
1636
|
|
|
1055
|
-
|
|
1637
|
+
By default we use the owners implementation.
|
|
1056
1638
|
|
|
1057
|
-
|
|
1639
|
+
Returns **[Tag](#tag)** as defined in the owner
|
|
1058
1640
|
|
|
1059
|
-
|
|
1641
|
+
### entryClass
|
|
1060
1642
|
|
|
1061
|
-
|
|
1643
|
+
By default we use the owners implementation.
|
|
1062
1644
|
|
|
1063
|
-
|
|
1645
|
+
Returns **ContentEntry** as defined in the owner
|
|
1064
1646
|
|
|
1065
|
-
|
|
1647
|
+
### hookClass
|
|
1066
1648
|
|
|
1067
|
-
|
|
1649
|
+
By default we use the owners implementation.
|
|
1068
1650
|
|
|
1069
|
-
|
|
1651
|
+
Returns **[Hook](#hook)** as defined in the owner
|
|
1070
1652
|
|
|
1071
|
-
|
|
1653
|
+
### addMethodName
|
|
1072
1654
|
|
|
1073
|
-
|
|
1655
|
+
Method name to be called to register one instance in the owner.
|
|
1656
|
+
sample: Application => \_addApplication
|
|
1074
1657
|
|
|
1075
|
-
|
|
1658
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1076
1659
|
|
|
1077
|
-
|
|
1660
|
+
### deleteMethodName
|
|
1078
1661
|
|
|
1079
|
-
|
|
1662
|
+
Method name to be called to unregister one instance in the owner.
|
|
1663
|
+
sample: Application => \_deleteApplication
|
|
1080
1664
|
|
|
1081
|
-
|
|
1665
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1082
1666
|
|
|
1083
1667
|
## OwnedObject
|
|
1084
1668
|
|
|
@@ -1121,7 +1705,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
1121
1705
|
|
|
1122
1706
|
Url of issue tracking system.
|
|
1123
1707
|
|
|
1124
|
-
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
|
|
1125
1709
|
|
|
1126
1710
|
### isLocked
|
|
1127
1711
|
|
|
@@ -1243,7 +1827,7 @@ Returns **[Tag](#tag)** as defined in the owner
|
|
|
1243
1827
|
|
|
1244
1828
|
By default we use the owners implementation.
|
|
1245
1829
|
|
|
1246
|
-
Returns **
|
|
1830
|
+
Returns **ContentEntry** as defined in the owner
|
|
1247
1831
|
|
|
1248
1832
|
### hookClass
|
|
1249
1833
|
|
|
@@ -1419,14 +2003,94 @@ Draft state of the pull request.
|
|
|
1419
2003
|
|
|
1420
2004
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
1421
2005
|
|
|
1422
|
-
##
|
|
2006
|
+
## Ref
|
|
1423
2007
|
|
|
1424
|
-
|
|
2008
|
+
**Extends OwnedObject**
|
|
1425
2009
|
|
|
1426
|
-
###
|
|
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))?** 
|
|
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)** 
|
|
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))>** 
|
|
2047
|
+
|
|
2048
|
+
### entry
|
|
2049
|
+
|
|
2050
|
+
Get exactly one matching entry by name (throws if entry is not found).
|
|
2051
|
+
|
|
2052
|
+
#### Parameters
|
|
1427
2053
|
|
|
1428
2054
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1429
2055
|
|
|
2056
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>** 
|
|
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)** 
|
|
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
|
+
|
|
1430
2094
|
## Ref
|
|
1431
2095
|
|
|
1432
2096
|
**Extends OwnedObject**
|
|
@@ -1453,13 +2117,13 @@ List entries of the branch.
|
|
|
1453
2117
|
|
|
1454
2118
|
* `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))?** 
|
|
1455
2119
|
|
|
1456
|
-
Returns **AsyncGenerator
|
|
2120
|
+
Returns **AsyncGenerator\<ContentEntry>** all matching entries in the branch
|
|
1457
2121
|
|
|
1458
2122
|
### asyncIterator
|
|
1459
2123
|
|
|
1460
2124
|
List all entries of the branch.
|
|
1461
2125
|
|
|
1462
|
-
Returns **AsyncGenerator
|
|
2126
|
+
Returns **AsyncGenerator\<ContentEntry>** all entries in the branch
|
|
1463
2127
|
|
|
1464
2128
|
### maybeEntry
|
|
1465
2129
|
|
|
@@ -1469,7 +2133,7 @@ Get exactly one matching entry by name or undefine if no such entry is found.
|
|
|
1469
2133
|
|
|
1470
2134
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1471
2135
|
|
|
1472
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<(
|
|
2136
|
+
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))>** 
|
|
1473
2137
|
|
|
1474
2138
|
### entry
|
|
1475
2139
|
|
|
@@ -1479,7 +2143,7 @@ Get exactly one matching entry by name (throws if entry is not found).
|
|
|
1479
2143
|
|
|
1480
2144
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1481
2145
|
|
|
1482
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
2146
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>** 
|
|
1483
2147
|
|
|
1484
2148
|
### repository
|
|
1485
2149
|
|
|
@@ -1568,7 +2232,7 @@ Mixin to define a class able to handle a collection of repositories.
|
|
|
1568
2232
|
|
|
1569
2233
|
## Repository
|
|
1570
2234
|
|
|
1571
|
-
|
|
2235
|
+
Abstract repository
|
|
1572
2236
|
|
|
1573
2237
|
### Parameters
|
|
1574
2238
|
|
|
@@ -1581,8 +2245,6 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
|
|
|
1581
2245
|
|
|
1582
2246
|
### Properties
|
|
1583
2247
|
|
|
1584
|
-
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
|
|
1585
|
-
Abstract repository
|
|
1586
2248
|
* `owner` **[RepositoryOwner](#repositoryowner)** 
|
|
1587
2249
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** without (#branch)
|
|
1588
2250
|
* `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.description
|
|
@@ -1607,7 +2269,7 @@ Lookup entries form the head of the default branch.
|
|
|
1607
2269
|
|
|
1608
2270
|
* `name`  
|
|
1609
2271
|
|
|
1610
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
|
2272
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>** 
|
|
1611
2273
|
|
|
1612
2274
|
### entries
|
|
1613
2275
|
|
|
@@ -1617,7 +2279,7 @@ List entries of the default branch.
|
|
|
1617
2279
|
|
|
1618
2280
|
* `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))?** 
|
|
1619
2281
|
|
|
1620
|
-
Returns **AsyncIterable
|
|
2282
|
+
Returns **AsyncIterable\<ContentEntry>** all matching entries in the branch
|
|
1621
2283
|
|
|
1622
2284
|
### maybeEntry
|
|
1623
2285
|
|
|
@@ -1627,7 +2289,7 @@ Get exactly one matching entry by name or undefined if no such entry is found.
|
|
|
1627
2289
|
|
|
1628
2290
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
1629
2291
|
|
|
1630
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<(
|
|
2292
|
+
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))>** 
|
|
1631
2293
|
|
|
1632
2294
|
### commits
|
|
1633
2295
|
|
|
@@ -1929,6 +2591,18 @@ Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_O
|
|
|
1929
2591
|
|
|
1930
2592
|
Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Tag](#tag)>
|
|
1931
2593
|
|
|
2594
|
+
## projects
|
|
2595
|
+
|
|
2596
|
+
Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Project](#project)>
|
|
2597
|
+
|
|
2598
|
+
## applications
|
|
2599
|
+
|
|
2600
|
+
Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Application](#application)>
|
|
2601
|
+
|
|
2602
|
+
## milestones
|
|
2603
|
+
|
|
2604
|
+
Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Milestone](#milestone)>
|
|
2605
|
+
|
|
1932
2606
|
## pullRequests
|
|
1933
2607
|
|
|
1934
2608
|
Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [PullRequest](#pullrequest)>
|