repository-provider 32.7.2 → 32.7.3

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 (6) hide show
  1. package/README.md +265 -296
  2. package/package.json +1 -1
  3. package/src/branch.mjs +1 -0
  4. package/src/owned-object.mjs +3 -1
  5. package/src/repository-owner.mjs +1 -1
  6. package/src/repository.mjs +1 -10
package/README.md CHANGED
@@ -141,78 +141,76 @@ console.log(await readme.getString());
141
141
  * [Parameters](#parameters-27)
142
142
  * [name](#name-1)
143
143
  * [messageDestination](#messagedestination-1)
144
- * [Branch](#branch)
145
- * [Parameters](#parameters-28)
146
- * [url](#url)
147
- * [refType](#reftype)
148
- * [isWritable](#iswritable-1)
149
- * [isDefault](#isdefault)
150
- * [delete](#delete)
151
- * [commit](#commit)
152
- * [Parameters](#parameters-29)
153
- * [commitIntoPullRequest](#commitintopullrequest)
154
- * [Parameters](#parameters-30)
155
- * [removeEntries](#removeentries)
156
- * [Parameters](#parameters-31)
157
- * [createPullRequest](#createpullrequest)
158
- * [Parameters](#parameters-32)
159
- * [createBranch](#createbranch)
160
- * [Parameters](#parameters-33)
161
144
  * [ContentEntry](#contententry)
162
- * [Parameters](#parameters-34)
145
+ * [Parameters](#parameters-28)
163
146
  * [Properties](#properties-3)
164
147
  * [ContentEntry](#contententry-1)
165
148
  * [Properties](#properties-4)
166
149
  * [ContentEntry](#contententry-2)
167
- * [Parameters](#parameters-35)
150
+ * [Parameters](#parameters-29)
168
151
  * [Properties](#properties-5)
152
+ * [url](#url)
153
+ * [refType](#reftype)
154
+ * [isWritable](#iswritable-1)
155
+ * [isDefault](#isdefault)
156
+ * [delete](#delete)
157
+ * [commit](#commit)
158
+ * [Parameters](#parameters-30)
159
+ * [commitIntoPullRequest](#commitintopullrequest)
160
+ * [Parameters](#parameters-31)
161
+ * [removeEntries](#removeentries)
162
+ * [Parameters](#parameters-32)
163
+ * [createPullRequest](#createpullrequest)
164
+ * [Parameters](#parameters-33)
165
+ * [createBranch](#createbranch)
166
+ * [Parameters](#parameters-34)
169
167
  * [CommitResult](#commitresult)
170
168
  * [Properties](#properties-6)
171
169
  * [Commit](#commit-1)
172
- * [Parameters](#parameters-36)
170
+ * [Parameters](#parameters-35)
173
171
  * [Properties](#properties-7)
174
172
  * [Hook](#hook)
175
173
  * [Issue](#issue)
176
174
  * [Milestone](#milestone)
177
175
  * [MultiGroupProvider](#multigroupprovider)
178
176
  * [repository](#repository)
177
+ * [Parameters](#parameters-36)
178
+ * [branch](#branch)
179
179
  * [Parameters](#parameters-37)
180
- * [branch](#branch-1)
181
- * [Parameters](#parameters-38)
182
180
  * [repositoryGroup](#repositorygroup)
183
- * [Parameters](#parameters-39)
181
+ * [Parameters](#parameters-38)
184
182
  * [repositoryGroups](#repositorygroups)
185
- * [Parameters](#parameters-40)
183
+ * [Parameters](#parameters-39)
186
184
  * [createRepositoryGroup](#createrepositorygroup)
187
- * [Parameters](#parameters-41)
185
+ * [Parameters](#parameters-40)
188
186
  * [addRepositoryGroup](#addrepositorygroup)
189
- * [Parameters](#parameters-42)
187
+ * [Parameters](#parameters-41)
190
188
  * [NamedObject](#namedobject)
191
- * [Parameters](#parameters-43)
189
+ * [Parameters](#parameters-42)
192
190
  * [Properties](#properties-8)
193
191
  * [equals](#equals-2)
194
- * [Parameters](#parameters-44)
192
+ * [Parameters](#parameters-43)
195
193
  * [toJSON](#tojson-1)
196
194
  * [OwnedObject](#ownedobject)
197
- * [Parameters](#parameters-45)
195
+ * [Parameters](#parameters-44)
198
196
  * [delete](#delete-1)
199
197
  * [equals](#equals-3)
200
- * [Parameters](#parameters-46)
198
+ * [Parameters](#parameters-45)
201
199
  * [api](#api)
202
200
  * [url](#url-1)
203
201
  * [provider](#provider-1)
204
202
  * [identifier](#identifier)
205
203
  * [fullName](#fullname-1)
206
204
  * [trace](#trace)
207
- * [Parameters](#parameters-47)
205
+ * [Parameters](#parameters-46)
208
206
  * [info](#info)
209
- * [Parameters](#parameters-48)
207
+ * [Parameters](#parameters-47)
210
208
  * [warn](#warn)
211
- * [Parameters](#parameters-49)
209
+ * [Parameters](#parameters-48)
212
210
  * [error](#error)
213
- * [Parameters](#parameters-50)
211
+ * [Parameters](#parameters-49)
214
212
  * [debug](#debug)
215
- * [Parameters](#parameters-51)
213
+ * [Parameters](#parameters-50)
216
214
  * [repositoryClass](#repositoryclass-1)
217
215
  * [pullRequestClass](#pullrequestclass-1)
218
216
  * [branchClass](#branchclass-1)
@@ -223,23 +221,23 @@ console.log(await readme.getString());
223
221
  * [deleteMethodName](#deletemethodname)
224
222
  * [Project](#project)
225
223
  * [PullRequest](#pullrequest)
226
- * [Parameters](#parameters-52)
224
+ * [Parameters](#parameters-51)
227
225
  * [Properties](#properties-9)
228
226
  * [fullName](#fullname-2)
229
227
  * [url](#url-2)
230
228
  * [repository](#repository-1)
231
229
  * [delete](#delete-2)
232
230
  * [merge](#merge)
233
- * [Parameters](#parameters-53)
231
+ * [Parameters](#parameters-52)
234
232
  * [decline](#decline)
235
233
  * [reviews](#reviews)
236
234
  * [identifier](#identifier-1)
237
235
  * [defaultListStates](#defaultliststates)
238
236
  * [validMergeMethods](#validmergemethods)
239
237
  * [list](#list-1)
240
- * [Parameters](#parameters-54)
238
+ * [Parameters](#parameters-53)
241
239
  * [open](#open)
242
- * [Parameters](#parameters-55)
240
+ * [Parameters](#parameters-54)
243
241
  * [state](#state)
244
242
  * [locked](#locked)
245
243
  * [merged](#merged)
@@ -248,16 +246,15 @@ console.log(await readme.getString());
248
246
  * [ref](#ref-1)
249
247
  * [refId](#refid)
250
248
  * [entries](#entries)
251
- * [Parameters](#parameters-56)
249
+ * [Parameters](#parameters-55)
252
250
  * [asyncIterator](#asynciterator)
253
251
  * [maybeEntry](#maybeentry)
254
- * [Parameters](#parameters-57)
252
+ * [Parameters](#parameters-56)
255
253
  * [entry](#entry)
256
- * [Parameters](#parameters-58)
254
+ * [Parameters](#parameters-57)
257
255
  * [repository](#repository-2)
258
256
  * [fullName](#fullname-3)
259
257
  * [fullCondensedName](#fullcondensedname-1)
260
- * [toString](#tostring-1)
261
258
  * [issuesURL](#issuesurl)
262
259
  * [homePageURL](#homepageurl)
263
260
  * [isLocked](#islocked)
@@ -267,90 +264,88 @@ console.log(await readme.getString());
267
264
  * [attributes](#attributes-1)
268
265
  * [isProtected](#isprotected-1)
269
266
  * [RepositoryGroup](#repositorygroup-1)
270
- * [Parameters](#parameters-59)
267
+ * [Parameters](#parameters-58)
271
268
  * [Properties](#properties-10)
272
269
  * [attributeMapping](#attributemapping-1)
273
270
  * [type](#type-1)
274
271
  * [homePageURL](#homepageurl-1)
275
272
  * [RepositoryOwner](#repositoryowner)
273
+ * [Parameters](#parameters-59)
274
+ * [fullName](#fullname-4)
275
+ * [slug](#slug)
276
+ * [entry](#entry-1)
276
277
  * [Parameters](#parameters-60)
277
- * [Repository](#repository-3)
278
+ * [entries](#entries-1)
278
279
  * [Parameters](#parameters-61)
279
- * [fullName](#fullname-4)
280
- * [slug](#slug)
281
- * [entry](#entry-1)
282
- * [Parameters](#parameters-62)
283
- * [entries](#entries-1)
284
- * [Parameters](#parameters-63)
285
- * [maybeEntry](#maybeentry-1)
286
- * [Parameters](#parameters-64)
287
- * [commits](#commits)
288
- * [Parameters](#parameters-65)
289
- * [cloneURL](#cloneurl)
290
- * [issuesURL](#issuesurl-1)
291
- * [homePageURL](#homepageurl-2)
292
- * [isArchived](#isarchived-1)
293
- * [isLocked](#islocked-1)
294
- * [isDisabled](#isdisabled-1)
295
- * [isTemplate](#istemplate)
296
- * [delete](#delete-3)
297
- * [defaultBranch](#defaultbranch)
298
- * [branch](#branch-2)
299
- * [Parameters](#parameters-66)
300
- * [hasBranches](#hasbranches)
301
- * [branches](#branches-1)
302
- * [Parameters](#parameters-67)
303
- * [createBranch](#createbranch-1)
304
- * [Parameters](#parameters-68)
305
- * [addBranch](#addbranch)
306
- * [Parameters](#parameters-69)
307
- * [deleteBranch](#deletebranch)
308
- * [Parameters](#parameters-70)
309
- * [tag](#tag)
310
- * [Parameters](#parameters-71)
311
- * [tags](#tags-1)
312
- * [Parameters](#parameters-72)
313
- * [addTag](#addtag)
314
- * [Parameters](#parameters-73)
315
- * [createPullRequest](#createpullrequest-1)
316
- * [Parameters](#parameters-74)
317
- * [addPullRequest](#addpullrequest)
318
- * [Parameters](#parameters-75)
319
- * [pullRequests](#pullrequests-1)
320
- * [pullRequest](#pullrequest-1)
321
- * [Parameters](#parameters-76)
322
- * [deletePullRequest](#deletepullrequest)
323
- * [Parameters](#parameters-77)
324
- * [addHook](#addhook)
325
- * [Parameters](#parameters-78)
326
- * [createHook](#createhook)
327
- * [Parameters](#parameters-79)
328
- * [hooks](#hooks-1)
329
- * [hook](#hook-1)
330
- * [Parameters](#parameters-80)
331
- * [type](#type-2)
332
- * [refId](#refid-1)
333
- * [Parameters](#parameters-81)
334
- * [attributes](#attributes-2)
280
+ * [maybeEntry](#maybeentry-1)
281
+ * [Parameters](#parameters-62)
282
+ * [commits](#commits)
283
+ * [Parameters](#parameters-63)
284
+ * [cloneURL](#cloneurl)
285
+ * [issuesURL](#issuesurl-1)
286
+ * [homePageURL](#homepageurl-2)
287
+ * [isArchived](#isarchived-1)
288
+ * [isLocked](#islocked-1)
289
+ * [isDisabled](#isdisabled-1)
290
+ * [isTemplate](#istemplate)
291
+ * [delete](#delete-3)
292
+ * [defaultBranch](#defaultbranch)
293
+ * [branch](#branch-1)
294
+ * [Parameters](#parameters-64)
295
+ * [hasBranches](#hasbranches)
296
+ * [branches](#branches-1)
297
+ * [Parameters](#parameters-65)
298
+ * [createBranch](#createbranch-1)
299
+ * [Parameters](#parameters-66)
300
+ * [addBranch](#addbranch)
301
+ * [Parameters](#parameters-67)
302
+ * [deleteBranch](#deletebranch)
303
+ * [Parameters](#parameters-68)
304
+ * [tag](#tag)
305
+ * [Parameters](#parameters-69)
306
+ * [tags](#tags-1)
307
+ * [Parameters](#parameters-70)
308
+ * [addTag](#addtag)
309
+ * [Parameters](#parameters-71)
310
+ * [createPullRequest](#createpullrequest-1)
311
+ * [Parameters](#parameters-72)
312
+ * [addPullRequest](#addpullrequest)
313
+ * [Parameters](#parameters-73)
314
+ * [pullRequests](#pullrequests-1)
315
+ * [pullRequest](#pullrequest-1)
316
+ * [Parameters](#parameters-74)
317
+ * [deletePullRequest](#deletepullrequest)
318
+ * [Parameters](#parameters-75)
319
+ * [addHook](#addhook)
320
+ * [Parameters](#parameters-76)
321
+ * [createHook](#createhook)
322
+ * [Parameters](#parameters-77)
323
+ * [hooks](#hooks-1)
324
+ * [hook](#hook-1)
325
+ * [Parameters](#parameters-78)
326
+ * [type](#type-2)
327
+ * [refId](#refid-1)
328
+ * [Parameters](#parameters-79)
329
+ * [attributes](#attributes-2)
335
330
  * [defaultBranchName](#defaultbranchname)
336
331
  * [Review](#review)
337
332
  * [SingleGroupProvider](#singlegroupprovider)
338
- * [repository](#repository-4)
339
- * [Parameters](#parameters-82)
333
+ * [repository](#repository-3)
334
+ * [Parameters](#parameters-80)
340
335
  * [repositoryGroup](#repositorygroup-2)
341
- * [Parameters](#parameters-83)
336
+ * [Parameters](#parameters-81)
342
337
  * [repositoryGroups](#repositorygroups-1)
343
- * [Parameters](#parameters-84)
338
+ * [Parameters](#parameters-82)
344
339
  * [Tag](#tag-1)
345
340
  * [refType](#reftype-1)
346
341
  * [asArray](#asarray)
347
- * [Parameters](#parameters-85)
342
+ * [Parameters](#parameters-83)
348
343
  * [stripBaseName](#stripbasename)
349
- * [Parameters](#parameters-86)
344
+ * [Parameters](#parameters-84)
350
345
  * [stripBaseNames](#stripbasenames)
351
- * [Parameters](#parameters-87)
346
+ * [Parameters](#parameters-85)
352
347
  * [generateBranchName](#generatebranchname)
353
- * [Parameters](#parameters-88)
348
+ * [Parameters](#parameters-86)
354
349
 
355
350
  ## Application
356
351
 
@@ -709,7 +704,7 @@ Create a repository.
709
704
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of group and repository
710
705
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
711
706
 
712
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**&#x20;
707
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Repository>**&#x20;
713
708
 
714
709
  ### list
715
710
 
@@ -748,7 +743,7 @@ List repositories.
748
743
 
749
744
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
750
745
 
751
- Returns **AsyncIterator<[Repository](#repository)>** all matching repos of the provider
746
+ Returns **AsyncIterator\<Repository>** all matching repos of the provider
752
747
 
753
748
  ### branches
754
749
 
@@ -758,7 +753,7 @@ List branches.
758
753
 
759
754
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
760
755
 
761
- Returns **AsyncIterator<[Branch](#branch)>** all matching branches of the provider
756
+ Returns **AsyncIterator\<Branch>** all matching branches of the provider
762
757
 
763
758
  ### tags
764
759
 
@@ -883,49 +878,93 @@ Name of the provider.
883
878
 
884
879
  To forward info/warn and error messages to
885
880
 
886
- ## Branch
881
+ ## ContentEntry
887
882
 
888
- **Extends Ref**
883
+ * **See**: [Repository#\_addBranch](Repository#_addBranch)
884
+
885
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
889
886
 
890
887
  ### Parameters
891
888
 
892
- * `owner` &#x20;
893
- * `name` (optional, default `owner.defaultBranchName`)
894
- * `options` &#x20;
889
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
890
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
891
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
895
892
 
896
- ### url
893
+ ### Properties
894
+
895
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
896
+ Abstract branch.
897
+ * `repository` **Repository**&#x20;
898
+ * `provider` **Provider**&#x20;
899
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
900
+
901
+ ## ContentEntry
902
+
903
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
904
+
905
+ ### Properties
906
+
907
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
908
+
909
+ ## ContentEntry
910
+
911
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
912
+
913
+ ### Parameters
914
+
915
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
916
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (#branch) will be removed
917
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
918
+
919
+ * `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable description
920
+ * `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** internal id
921
+
922
+ ### Properties
923
+
924
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
925
+ Abstract repository
926
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
927
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** without (#branch)
928
+ * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.description
929
+ * `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.id
930
+ * `branches` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), Branch>**&#x20;
931
+ * `tags` **[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)>**&#x20;
932
+ * `pullRequests` **[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)>**&#x20;
933
+ * `milestones` **[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)>**&#x20;
934
+
935
+ ## url
897
936
 
898
937
  Deliver repository and branch url combined.
899
938
 
900
939
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repoUrl#branch'
901
940
 
902
- ### refType
941
+ ## refType
903
942
 
904
943
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** heades
905
944
 
906
- ### isWritable
945
+ ## isWritable
907
946
 
908
947
  Returns **any** true if not [isArchived](isArchived) and [isDisabled](isDisabled) and [isLocked](isLocked)
909
948
 
910
- ### isDefault
949
+ ## isDefault
911
950
 
912
951
  Are we the default branch.
913
952
 
914
953
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name matches the repository default branch
915
954
 
916
- ### delete
955
+ ## delete
917
956
 
918
- * **See**: [Repository#deleteBranch](#repositorydeletebranch)
957
+ * **See**: [Repository#deleteBranch](Repository#deleteBranch)
919
958
 
920
- Delete the branch from the [Repository](#repository).
959
+ Delete the branch from the [Repository](Repository).
921
960
 
922
961
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
923
962
 
924
- ### commit
963
+ ## commit
925
964
 
926
965
  Commit entries.
927
966
 
928
- #### Parameters
967
+ ### Parameters
929
968
 
930
969
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
931
970
  * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** content to be commited
@@ -933,16 +972,16 @@ Commit entries.
933
972
 
934
973
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>**&#x20;
935
974
 
936
- ### commitIntoPullRequest
975
+ ## commitIntoPullRequest
937
976
 
938
977
  Add commits into a pull request.
939
978
 
940
- #### Parameters
979
+ ### Parameters
941
980
 
942
981
  * `commits` **([Commit](#commit) | AsyncIterator<[Commit](#commit)>)** to be commited
943
982
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
944
983
 
945
- * `options.pullRequestBranch` **([Branch](#branch) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** to commit into
984
+ * `options.pullRequestBranch` **(Branch | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** to commit into
946
985
  * `options.dry` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a branch and do not commit only create dummy PR
947
986
  * `options.skipWithoutCommits` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a PR if no commits are given
948
987
  * `options.bodyFromCommitMessages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** generate body from commit messages
@@ -950,90 +989,36 @@ Add commits into a pull request.
950
989
 
951
990
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**&#x20;
952
991
 
953
- ### removeEntries
992
+ ## removeEntries
954
993
 
955
994
  Remove entries form the branch.
956
995
 
957
- #### Parameters
996
+ ### Parameters
958
997
 
959
998
  * `entries` **AsyncIterator<[ContentEntry](#contententry)>**&#x20;
960
999
 
961
- ### createPullRequest
1000
+ ## createPullRequest
962
1001
 
963
1002
  Create a pull request.
964
1003
 
965
- #### Parameters
1004
+ ### Parameters
966
1005
 
967
- * `toBranch` **[Branch](#branch)**&#x20;
1006
+ * `toBranch` **Branch**&#x20;
968
1007
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
969
1008
 
970
1009
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**&#x20;
971
1010
 
972
- ### createBranch
1011
+ ## createBranch
973
1012
 
974
- Create a new [Branch](#branch) by cloning a given source branch.
1013
+ Create a new [Branch](Branch) by cloning a given source branch.
975
1014
  Simply calls Repository.createBranch() with the receiver as source branch
976
1015
 
977
- #### Parameters
978
-
979
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the new branch
980
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
981
-
982
- 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)
983
-
984
- ## ContentEntry
985
-
986
- * **See**: [Repository#\_addBranch](Repository#_addBranch)
987
-
988
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
989
-
990
1016
  ### Parameters
991
1017
 
992
- * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
993
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1018
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** the new branch
994
1019
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
995
1020
 
996
- ### Properties
997
-
998
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
999
- Abstract branch.
1000
- * `repository` **[Repository](#repository)**&#x20;
1001
- * `provider` **Provider**&#x20;
1002
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1003
-
1004
- ## ContentEntry
1005
-
1006
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1007
-
1008
- ### Properties
1009
-
1010
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1011
-
1012
- ## ContentEntry
1013
-
1014
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1015
-
1016
- ### Parameters
1017
-
1018
- * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1019
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (#branch) will be removed
1020
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1021
-
1022
- * `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable description
1023
- * `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** internal id
1024
-
1025
- ### Properties
1026
-
1027
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
1028
- Abstract repository
1029
- * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1030
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** without (#branch)
1031
- * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.description
1032
- * `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.id
1033
- * `branches` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Branch](#branch)>**&#x20;
1034
- * `tags` **[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)>**&#x20;
1035
- * `pullRequests` **[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)>**&#x20;
1036
- * `milestones` **[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)>**&#x20;
1021
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Branch>** newly created branch (or already present old one with the same name)
1037
1022
 
1038
1023
  ## CommitResult
1039
1024
 
@@ -1051,7 +1036,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
1051
1036
 
1052
1037
  ### Properties
1053
1038
 
1054
- * `repository` **[Repository](#repository)**&#x20;
1039
+ * `repository` **Repository**&#x20;
1055
1040
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1056
1041
  * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1057
1042
  * `author` **User**&#x20;
@@ -1085,7 +1070,7 @@ Lookup a repository in the provider and all of its repository groups.
1085
1070
 
1086
1071
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1087
1072
 
1088
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**&#x20;
1073
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Repository>**&#x20;
1089
1074
 
1090
1075
  ### branch
1091
1076
 
@@ -1095,7 +1080,7 @@ Lookup a branch.
1095
1080
 
1096
1081
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
1097
1082
 
1098
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>**&#x20;
1083
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Branch>**&#x20;
1099
1084
 
1100
1085
  ### repositoryGroup
1101
1086
 
@@ -1324,12 +1309,12 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1324
1309
  **Extends OwnedObject**
1325
1310
 
1326
1311
  Abstract pull request.
1327
- [Repository#addPullRequest](#repositoryaddpullrequest)
1312
+ [Repository#addPullRequest](Repository#addPullRequest)
1328
1313
 
1329
1314
  ### Parameters
1330
1315
 
1331
- * `source` **[Branch](#branch)** merge source
1332
- * `owner` **[Branch](#branch)** merge target
1316
+ * `source` **Branch** merge source
1317
+ * `owner` **Branch** merge target
1333
1318
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1334
1319
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1335
1320
 
@@ -1341,8 +1326,8 @@ Abstract pull request.
1341
1326
  ### Properties
1342
1327
 
1343
1328
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1344
- * `source` **[Branch](#branch)**&#x20;
1345
- * `destination` **[Branch](#branch)**&#x20;
1329
+ * `source` **Branch**&#x20;
1330
+ * `destination` **Branch**&#x20;
1346
1331
  * `title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
1347
1332
  * `state` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
1348
1333
  * `merged` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?**&#x20;
@@ -1363,13 +1348,13 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1363
1348
 
1364
1349
  ### repository
1365
1350
 
1366
- Returns **[Repository](#repository)** destination repository
1351
+ Returns **Repository** destination repository
1367
1352
 
1368
1353
  ### delete
1369
1354
 
1370
- * **See**: [Repository#deletePullRequest](#repositorydeletepullrequest)
1355
+ * **See**: [Repository#deletePullRequest](Repository#deletePullRequest)
1371
1356
 
1372
- Delete the pull request from the [Repository](#repository).
1357
+ Delete the pull request from the [Repository](Repository).
1373
1358
 
1374
1359
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**&#x20;
1375
1360
 
@@ -1414,11 +1399,11 @@ Result will be filtered by source branch, destination branch and states
1414
1399
 
1415
1400
  #### Parameters
1416
1401
 
1417
- * `repository` **[Repository](#repository)**&#x20;
1402
+ * `repository` **Repository**&#x20;
1418
1403
  * `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1419
1404
 
1420
- * `filter.source` **[Branch](#branch)?**&#x20;
1421
- * `filter.destination` **[Branch](#branch)?**&#x20;
1405
+ * `filter.source` **Branch?**&#x20;
1406
+ * `filter.destination` **Branch?**&#x20;
1422
1407
  * `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**&#x20;
1423
1408
 
1424
1409
  Returns **AsyncIterator<[PullRequest](#pullrequest)>**&#x20;
@@ -1429,8 +1414,8 @@ Open a pull request
1429
1414
 
1430
1415
  #### Parameters
1431
1416
 
1432
- * `source` **[Branch](#branch)**&#x20;
1433
- * `destination` **[Branch](#branch)**&#x20;
1417
+ * `source` **Branch**&#x20;
1418
+ * `destination` **Branch**&#x20;
1434
1419
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1435
1420
 
1436
1421
  ## state
@@ -1522,7 +1507,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
1522
1507
  Ref owner.
1523
1508
  By default we provide the repository owner
1524
1509
 
1525
- Returns **[Repository](#repository)**&#x20;
1510
+ Returns **Repository**&#x20;
1526
1511
 
1527
1512
  ### fullName
1528
1513
 
@@ -1537,15 +1522,9 @@ But skipping the branch name if it is the default branch.
1537
1522
 
1538
1523
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'user/repo#branch'
1539
1524
 
1540
- ### toString
1541
-
1542
- Same as identifier.
1543
-
1544
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1545
-
1546
1525
  ### issuesURL
1547
1526
 
1548
- * **See**: [Repository#issuesURL](#repositoryissuesurl)
1527
+ * **See**: [Repository#issuesURL](Repository#issuesURL)
1549
1528
 
1550
1529
  Url of issue tracking system.
1551
1530
 
@@ -1553,7 +1532,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1553
1532
 
1554
1533
  ### homePageURL
1555
1534
 
1556
- * **See**: [Repository#homePageURL](#repositoryhomepageurl)
1535
+ * **See**: [Repository#homePageURL](Repository#homePageURL)
1557
1536
 
1558
1537
  Url of home page.
1559
1538
 
@@ -1629,312 +1608,302 @@ Mixin to define a class able to handle a collection of repositories.
1629
1608
 
1630
1609
  * `base` **Class** to be extendet
1631
1610
 
1632
- ## Repository
1633
-
1634
- **Extends OwnedObject**
1635
-
1636
- ### Parameters
1637
-
1638
- * `owner` &#x20;
1639
- * `name` &#x20;
1640
- * `options` &#x20;
1641
-
1642
- ### fullName
1611
+ ## fullName
1643
1612
 
1644
1613
  Full repository name within the provider.
1645
1614
 
1646
1615
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** full repo name
1647
1616
 
1648
- ### slug
1617
+ ## slug
1649
1618
 
1650
1619
  Name of the repo as used in the URL.
1651
1620
 
1652
1621
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1653
1622
 
1654
- ### entry
1623
+ ## entry
1655
1624
 
1656
1625
  Lookup entries form the head of the default branch.
1657
1626
  [Branch#entry](Branch#entry)
1658
1627
 
1659
- #### Parameters
1628
+ ### Parameters
1660
1629
 
1661
1630
  * `name` &#x20;
1662
1631
 
1663
1632
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**&#x20;
1664
1633
 
1665
- ### entries
1634
+ ## entries
1666
1635
 
1667
1636
  List entries of the default branch.
1668
1637
 
1669
- #### Parameters
1638
+ ### Parameters
1670
1639
 
1671
1640
  * `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)>**&#x20;
1672
1641
 
1673
1642
  Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
1674
1643
 
1675
- ### maybeEntry
1644
+ ## maybeEntry
1676
1645
 
1677
1646
  Get exactly one matching entry by name or undefined if no such entry is found.
1678
1647
 
1679
- #### Parameters
1648
+ ### Parameters
1680
1649
 
1681
1650
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1682
1651
 
1683
1652
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**&#x20;
1684
1653
 
1685
- ### commits
1654
+ ## commits
1686
1655
 
1687
1656
  List commits of the default branch.
1688
1657
 
1689
- #### Parameters
1658
+ ### Parameters
1690
1659
 
1691
1660
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1692
1661
 
1693
1662
  Returns **AsyncIterator<[Commit](#commit)>** all matching commits in the repository
1694
1663
 
1695
- ### cloneURL
1664
+ ## cloneURL
1696
1665
 
1697
1666
  The url used for cloning the repo.
1698
1667
 
1699
1668
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1700
1669
 
1701
- ### issuesURL
1670
+ ## issuesURL
1702
1671
 
1703
1672
  The url of issue tracking system.
1704
1673
 
1705
1674
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1706
1675
 
1707
- ### homePageURL
1676
+ ## homePageURL
1708
1677
 
1709
1678
  The url of home page.
1710
1679
 
1711
1680
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1712
1681
 
1713
- ### isArchived
1682
+ ## isArchived
1714
1683
 
1715
1684
  By default we are not archived.
1716
1685
 
1717
1686
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
1718
1687
 
1719
- ### isLocked
1688
+ ## isLocked
1720
1689
 
1721
1690
  By default we are not locked.
1722
1691
 
1723
1692
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
1724
1693
 
1725
- ### isDisabled
1694
+ ## isDisabled
1726
1695
 
1727
1696
  By default we are not disabled.
1728
1697
 
1729
1698
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
1730
1699
 
1731
- ### isTemplate
1700
+ ## isTemplate
1732
1701
 
1733
1702
  By default we are not a template.
1734
1703
 
1735
1704
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
1736
1705
 
1737
- ### delete
1706
+ ## delete
1738
1707
 
1739
1708
  Delete the repository from the [Provider](Provider).
1740
1709
  [Provider#deleteRepository](Provider#deleteRepository)
1741
1710
 
1742
1711
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
1743
1712
 
1744
- ### defaultBranch
1713
+ ## defaultBranch
1745
1714
 
1746
1715
  Lookup the default branch.
1747
1716
 
1748
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** branch named after defaultBranchName
1717
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Branch>** branch named after defaultBranchName
1749
1718
 
1750
- ### branch
1719
+ ## branch
1751
1720
 
1752
1721
  Lookup branch by name.
1753
1722
 
1754
- #### Parameters
1723
+ ### Parameters
1755
1724
 
1756
1725
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1757
1726
 
1758
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>**&#x20;
1727
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Branch>**&#x20;
1759
1728
 
1760
- ### hasBranches
1729
+ ## hasBranches
1761
1730
 
1762
1731
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there is at least one branch
1763
1732
 
1764
- ### branches
1733
+ ## branches
1765
1734
 
1766
- #### Parameters
1735
+ ### Parameters
1767
1736
 
1768
1737
  * `patterns` &#x20;
1769
1738
 
1770
- Returns **AsyncIterator<[Branch](#branch)>** of all branches
1739
+ Returns **AsyncIterator\<Branch>** of all branches
1771
1740
 
1772
- ### createBranch
1741
+ ## createBranch
1773
1742
 
1774
- Create a new [Branch](#branch) by cloning a given source branch.
1743
+ Create a new [Branch](Branch) by cloning a given source branch.
1775
1744
 
1776
- #### Parameters
1745
+ ### Parameters
1777
1746
 
1778
1747
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch
1779
- * `source` **[Branch](#branch)** branch defaults to the defaultBranch
1748
+ * `source` **Branch** branch defaults to the defaultBranch
1780
1749
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1781
1750
 
1782
- 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)
1751
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Branch>** newly created branch (or already present old one with the same name)
1783
1752
 
1784
- ### addBranch
1753
+ ## addBranch
1785
1754
 
1786
- Add a new [Branch](#branch).
1755
+ Add a new [Branch](Branch).
1787
1756
  Internal branch creation does not call repository.initialize()
1788
1757
 
1789
- #### Parameters
1758
+ ### Parameters
1790
1759
 
1791
1760
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch
1792
1761
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be passed to the branch
1793
1762
 
1794
- Returns **[Branch](#branch)** newly created branch
1763
+ Returns **Branch** newly created branch
1795
1764
 
1796
- ### deleteBranch
1765
+ ## deleteBranch
1797
1766
 
1798
- Delete a [Branch](#branch).
1767
+ Delete a [Branch](Branch).
1799
1768
 
1800
- #### Parameters
1769
+ ### Parameters
1801
1770
 
1802
1771
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
1803
1772
 
1804
1773
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
1805
1774
 
1806
- ### tag
1775
+ ## tag
1807
1776
 
1808
1777
  Get a Tag.
1809
1778
 
1810
- #### Parameters
1779
+ ### Parameters
1811
1780
 
1812
1781
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1813
1782
 
1814
1783
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>**&#x20;
1815
1784
 
1816
- ### tags
1785
+ ## tags
1817
1786
 
1818
- #### Parameters
1787
+ ### Parameters
1819
1788
 
1820
1789
  * `patterns` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
1821
1790
 
1822
1791
  Returns **AsyncIterator<[Tag](#tag)>** of all tags
1823
1792
 
1824
- ### addTag
1793
+ ## addTag
1825
1794
 
1826
1795
  Add a new [Tag](#tag).
1827
1796
  Internal tag creation does not call repository.initialize()
1828
1797
 
1829
- #### Parameters
1798
+ ### Parameters
1830
1799
 
1831
1800
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new tag
1832
1801
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1833
1802
 
1834
1803
  Returns **[Tag](#tag)** newly created tag
1835
1804
 
1836
- ### createPullRequest
1805
+ ## createPullRequest
1837
1806
 
1838
1807
  Create a pull request (or deliver an already present for the given name).
1839
1808
 
1840
- #### Parameters
1809
+ ### Parameters
1841
1810
 
1842
1811
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the pr
1843
- * `source` **[Branch](#branch)** branch
1812
+ * `source` **Branch** branch
1844
1813
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1845
1814
 
1846
1815
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**&#x20;
1847
1816
 
1848
- ### addPullRequest
1817
+ ## addPullRequest
1849
1818
 
1850
1819
  Add a pull request.
1851
1820
 
1852
- #### Parameters
1821
+ ### Parameters
1853
1822
 
1854
1823
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1855
- * `source` **[Branch](#branch)**&#x20;
1824
+ * `source` **Branch**&#x20;
1856
1825
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1857
1826
 
1858
1827
  Returns **[PullRequest](#pullrequest)**&#x20;
1859
1828
 
1860
- ### pullRequests
1829
+ ## pullRequests
1861
1830
 
1862
1831
  Deliver all [PullRequest](#pullrequest)s.
1863
1832
 
1864
1833
  Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
1865
1834
 
1866
- ### pullRequest
1835
+ ## pullRequest
1867
1836
 
1868
1837
  The @{link PullRequest} for a given name.
1869
1838
 
1870
- #### Parameters
1839
+ ### Parameters
1871
1840
 
1872
1841
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1873
1842
 
1874
1843
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**&#x20;
1875
1844
 
1876
- ### deletePullRequest
1845
+ ## deletePullRequest
1877
1846
 
1878
1847
  Delete a [PullRequest](#pullrequest).
1879
1848
 
1880
- #### Parameters
1849
+ ### Parameters
1881
1850
 
1882
1851
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1883
1852
 
1884
1853
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**&#x20;
1885
1854
 
1886
- ### addHook
1855
+ ## addHook
1887
1856
 
1888
1857
  Add a new [Hook](#hook).
1889
1858
 
1890
- #### Parameters
1859
+ ### Parameters
1891
1860
 
1892
1861
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new hoook name
1893
1862
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1894
1863
 
1895
1864
  Returns **[Hook](#hook)** newly created hook
1896
1865
 
1897
- ### createHook
1866
+ ## createHook
1898
1867
 
1899
1868
  Add a new Hook.
1900
1869
 
1901
- #### Parameters
1870
+ ### Parameters
1902
1871
 
1903
1872
  * `hook` **[Hook](#hook)**&#x20;
1904
1873
 
1905
- ### hooks
1874
+ ## hooks
1906
1875
 
1907
1876
  List hooks.
1908
1877
 
1909
1878
  Returns **AsyncIterator<[Hook](#hook)>** all hooks of the repository
1910
1879
 
1911
- ### hook
1880
+ ## hook
1912
1881
 
1913
1882
  Get a Hook.
1914
1883
 
1915
- #### Parameters
1884
+ ### Parameters
1916
1885
 
1917
1886
  * `id` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))**&#x20;
1918
1887
 
1919
1888
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Hook](#hook)>** for the given id
1920
1889
 
1921
- ### type
1890
+ ## type
1922
1891
 
1923
1892
  Get type of the repository.
1924
1893
 
1925
1894
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'git'
1926
1895
 
1927
- ### refId
1896
+ ## refId
1928
1897
 
1929
1898
  Get sha of a ref.
1930
1899
 
1931
- #### Parameters
1900
+ ### Parameters
1932
1901
 
1933
1902
  * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1934
1903
 
1935
1904
  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
1936
1905
 
1937
- ### attributes
1906
+ ## attributes
1938
1907
 
1939
1908
  options
1940
1909
 
@@ -1962,7 +1931,7 @@ Lookup a repository in the provider and all of its repository groups.
1962
1931
 
1963
1932
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1964
1933
 
1965
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**&#x20;
1934
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Repository>**&#x20;
1966
1935
 
1967
1936
  ### repositoryGroup
1968
1937
 
@@ -2038,7 +2007,7 @@ Find a new branch name for a given pattern.
2038
2007
 
2039
2008
  ### Parameters
2040
2009
 
2041
- * `repository` **[Repository](#repository)**&#x20;
2010
+ * `repository` **Repository**&#x20;
2042
2011
  * `pattern` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
2043
2012
 
2044
2013
  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)>**&#x20;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "32.7.2",
3
+ "version": "32.7.3",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
package/src/branch.mjs CHANGED
@@ -11,6 +11,7 @@ import { Commit } from "./commit.mjs";
11
11
 
12
12
  /**
13
13
  * Abstract branch.
14
+ * @class Branch
14
15
  * @see {@link Repository#_addBranch}
15
16
  * @param {RepositoryOwner} owner
16
17
  * @param {string} name
package/src/owned-object.mjs CHANGED
@@ -80,7 +80,9 @@ export class OwnedObject extends NamedObject {
80
80
  * @return {string} name with owner name
81
81
  */
82
82
  get fullName() {
83
- return this.owner.name + "/" + this.name;
83
+ return this.owner === this.provider || this.owner.name === undefined
84
+ ? this.name
85
+ : this.owner.name + "/" + this.name;
84
86
  }
85
87
 
86
88
  /**
package/src/repository-owner.mjs CHANGED
@@ -84,7 +84,7 @@ export function RepositoryOwner(base) {
84
84
  * @param {string} name
85
85
  * @param {function} [split]
86
86
  * @param {Object} [defaultItem]
87
- * @returns {NamedObject} from a repository
87
+ * @returns {Promise<NamedObject>} from a repository
88
88
  */
89
89
  async lookup(type, name, split, defaultItem) {
90
90
  if (name !== undefined) {
package/src/repository.mjs CHANGED
@@ -20,6 +20,7 @@ import {
20
20
 
21
21
  /**
22
22
  * Abstract repository
23
+ * @class Repository
23
24
  * @param {RepositoryOwner} owner
24
25
  * @param {string} name (#branch) will be removed
25
26
  * @param {Object} options
@@ -84,16 +85,6 @@ export class Repository extends OwnedObject {
84
85
  super(owner, owner.normalizeRepositoryName(name, false), options);
85
86
  }
86
87
 
87
- /**
88
- * Full repository name within the provider.
89
- * @return {string} full repo name
90
- */
91
- get fullName() {
92
- return this.owner === this.provider || this.owner.name === undefined
93
- ? this.name
94
- : [this.owner.name, this.name].join("/");
95
- }
96
-
97
88
  /**
98
89
  * Name of the repo as used in the URL.
99
90
  * @return {string}