repository-provider 26.4.0 → 26.4.1
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 +205 -190
- package/package.json +3 -3
- package/src/branch.mjs +0 -8
package/README.md
CHANGED
|
@@ -65,8 +65,22 @@ console.log(await readme.getString());
|
|
|
65
65
|
* [Parameters](#parameters-7)
|
|
66
66
|
* [BaseObject](#baseobject)
|
|
67
67
|
* [Parameters](#parameters-8)
|
|
68
|
+
* [update](#update)
|
|
68
69
|
* [equals](#equals)
|
|
69
70
|
* [Parameters](#parameters-9)
|
|
71
|
+
* [provider](#provider)
|
|
72
|
+
* [info](#info)
|
|
73
|
+
* [Parameters](#parameters-10)
|
|
74
|
+
* [warn](#warn)
|
|
75
|
+
* [Parameters](#parameters-11)
|
|
76
|
+
* [error](#error)
|
|
77
|
+
* [Parameters](#parameters-12)
|
|
78
|
+
* [repositoryClass](#repositoryclass)
|
|
79
|
+
* [pullRequestClass](#pullrequestclass)
|
|
80
|
+
* [branchClass](#branchclass)
|
|
81
|
+
* [tagClass](#tagclass)
|
|
82
|
+
* [entryClass](#entryclass)
|
|
83
|
+
* [hookClass](#hookclass)
|
|
70
84
|
* [attributes](#attributes)
|
|
71
85
|
* [writableAttributes](#writableattributes)
|
|
72
86
|
* [attributeMapping](#attributemapping)
|
|
@@ -76,131 +90,130 @@ console.log(await readme.getString());
|
|
|
76
90
|
* [avatarURL](#avatarurl)
|
|
77
91
|
* [homePageURL](#homepageurl)
|
|
78
92
|
* [MessageDestination](#messagedestination)
|
|
79
|
-
* [Parameters](#parameters-
|
|
93
|
+
* [Parameters](#parameters-13)
|
|
80
94
|
* [BaseProvider](#baseprovider)
|
|
81
|
-
* [Parameters](#parameters-
|
|
95
|
+
* [Parameters](#parameters-14)
|
|
82
96
|
* [Properties](#properties-1)
|
|
83
97
|
* [equals](#equals-1)
|
|
84
|
-
* [Parameters](#parameters-
|
|
98
|
+
* [Parameters](#parameters-15)
|
|
85
99
|
* [repositoryBases](#repositorybases)
|
|
86
100
|
* [normalizeRepositoryName](#normalizerepositoryname)
|
|
87
|
-
* [Parameters](#parameters-
|
|
101
|
+
* [Parameters](#parameters-16)
|
|
88
102
|
* [normalizeGroupName](#normalizegroupname)
|
|
89
|
-
* [Parameters](#parameters-
|
|
103
|
+
* [Parameters](#parameters-17)
|
|
90
104
|
* [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive)
|
|
91
105
|
* [areGroupNamesCaseSensitive](#aregroupnamescasesensitive)
|
|
92
106
|
* [supportsBase](#supportsbase)
|
|
93
|
-
* [Parameters](#parameters-
|
|
107
|
+
* [Parameters](#parameters-18)
|
|
94
108
|
* [parseName](#parsename)
|
|
95
|
-
* [Parameters](#parameters-
|
|
109
|
+
* [Parameters](#parameters-19)
|
|
96
110
|
* [createRepository](#createrepository)
|
|
97
|
-
* [Parameters](#parameters-
|
|
111
|
+
* [Parameters](#parameters-20)
|
|
98
112
|
* [list](#list)
|
|
99
|
-
* [Parameters](#parameters-
|
|
113
|
+
* [Parameters](#parameters-21)
|
|
100
114
|
* [projects](#projects)
|
|
101
|
-
* [Parameters](#parameters-
|
|
115
|
+
* [Parameters](#parameters-22)
|
|
102
116
|
* [milestones](#milestones)
|
|
103
|
-
* [Parameters](#parameters-
|
|
117
|
+
* [Parameters](#parameters-23)
|
|
104
118
|
* [repositories](#repositories)
|
|
105
|
-
* [Parameters](#parameters-
|
|
119
|
+
* [Parameters](#parameters-24)
|
|
106
120
|
* [branches](#branches)
|
|
107
|
-
* [Parameters](#parameters-
|
|
121
|
+
* [Parameters](#parameters-25)
|
|
108
122
|
* [tags](#tags)
|
|
109
|
-
* [Parameters](#parameters-
|
|
123
|
+
* [Parameters](#parameters-26)
|
|
110
124
|
* [hooks](#hooks)
|
|
111
|
-
* [Parameters](#parameters-
|
|
125
|
+
* [Parameters](#parameters-27)
|
|
112
126
|
* [pullRequests](#pullrequests)
|
|
113
|
-
* [Parameters](#parameters-
|
|
127
|
+
* [Parameters](#parameters-28)
|
|
114
128
|
* [name](#name)
|
|
115
|
-
* [provider](#provider)
|
|
129
|
+
* [provider](#provider-1)
|
|
116
130
|
* [url](#url)
|
|
117
131
|
* [toJSON](#tojson)
|
|
118
132
|
* [repositoryGroupClass](#repositorygroupclass)
|
|
119
|
-
* [hookClass](#hookclass)
|
|
120
|
-
* [repositoryClass](#repositoryclass)
|
|
121
|
-
* [branchClass](#branchclass)
|
|
122
|
-
* [
|
|
123
|
-
* [
|
|
133
|
+
* [hookClass](#hookclass-1)
|
|
134
|
+
* [repositoryClass](#repositoryclass-1)
|
|
135
|
+
* [branchClass](#branchclass-1)
|
|
136
|
+
* [tagClass](#tagclass-1)
|
|
137
|
+
* [entryClass](#entryclass-1)
|
|
138
|
+
* [pullRequestClass](#pullrequestclass-1)
|
|
124
139
|
* [instanceIdentifier](#instanceidentifier)
|
|
125
140
|
* [optionsFromEnvironment](#optionsfromenvironment)
|
|
126
|
-
* [Parameters](#parameters-
|
|
141
|
+
* [Parameters](#parameters-29)
|
|
127
142
|
* [areOptionsSufficcient](#areoptionssufficcient)
|
|
128
|
-
* [Parameters](#parameters-
|
|
143
|
+
* [Parameters](#parameters-30)
|
|
129
144
|
* [initialize](#initialize)
|
|
130
|
-
* [Parameters](#parameters-
|
|
145
|
+
* [Parameters](#parameters-31)
|
|
131
146
|
* [priority](#priority)
|
|
132
147
|
* [name](#name-1)
|
|
133
148
|
* [messageDestination](#messagedestination-1)
|
|
134
149
|
* [Commit](#commit)
|
|
135
150
|
* [Properties](#properties-2)
|
|
136
151
|
* [Commit](#commit-1)
|
|
137
|
-
* [Parameters](#parameters-
|
|
152
|
+
* [Parameters](#parameters-32)
|
|
138
153
|
* [Properties](#properties-3)
|
|
139
154
|
* [CommitResult](#commitresult)
|
|
140
155
|
* [Properties](#properties-4)
|
|
141
156
|
* [Branch](#branch)
|
|
142
|
-
* [Parameters](#parameters-
|
|
157
|
+
* [Parameters](#parameters-33)
|
|
143
158
|
* [Properties](#properties-5)
|
|
144
159
|
* [url](#url-1)
|
|
145
160
|
* [refType](#reftype)
|
|
146
161
|
* [isDefault](#isdefault)
|
|
147
162
|
* [delete](#delete)
|
|
148
163
|
* [commit](#commit-2)
|
|
149
|
-
* [Parameters](#parameters-
|
|
164
|
+
* [Parameters](#parameters-34)
|
|
150
165
|
* [commitIntoPullRequest](#commitintopullrequest)
|
|
151
|
-
* [Parameters](#parameters-
|
|
166
|
+
* [Parameters](#parameters-35)
|
|
152
167
|
* [removeEntries](#removeentries)
|
|
153
|
-
* [Parameters](#parameters-
|
|
154
|
-
* [entryClass](#entryclass-
|
|
168
|
+
* [Parameters](#parameters-36)
|
|
169
|
+
* [entryClass](#entryclass-2)
|
|
155
170
|
* [createPullRequest](#createpullrequest)
|
|
156
|
-
* [Parameters](#parameters-
|
|
157
|
-
* [pullRequestClass](#pullrequestclass-1)
|
|
171
|
+
* [Parameters](#parameters-37)
|
|
158
172
|
* [createBranch](#createbranch)
|
|
159
|
-
* [Parameters](#parameters-
|
|
173
|
+
* [Parameters](#parameters-38)
|
|
160
174
|
* [Hook](#hook)
|
|
161
|
-
* [Parameters](#parameters-
|
|
175
|
+
* [Parameters](#parameters-39)
|
|
162
176
|
* [Properties](#properties-6)
|
|
163
177
|
* [equals](#equals-2)
|
|
164
|
-
* [Parameters](#parameters-
|
|
178
|
+
* [Parameters](#parameters-40)
|
|
165
179
|
* [toJSON](#tojson-1)
|
|
166
180
|
* [Issue](#issue)
|
|
167
|
-
* [Parameters](#parameters-
|
|
181
|
+
* [Parameters](#parameters-41)
|
|
168
182
|
* [Milestone](#milestone)
|
|
169
|
-
* [Parameters](#parameters-
|
|
183
|
+
* [Parameters](#parameters-42)
|
|
170
184
|
* [MultiGroupProvider](#multigroupprovider)
|
|
171
|
-
* [Parameters](#parameters-
|
|
185
|
+
* [Parameters](#parameters-43)
|
|
172
186
|
* [repository](#repository)
|
|
173
|
-
* [Parameters](#parameters-
|
|
187
|
+
* [Parameters](#parameters-44)
|
|
174
188
|
* [repositoryGroup](#repositorygroup)
|
|
175
|
-
* [Parameters](#parameters-
|
|
189
|
+
* [Parameters](#parameters-45)
|
|
176
190
|
* [repositoryGroups](#repositorygroups)
|
|
177
|
-
* [Parameters](#parameters-
|
|
191
|
+
* [Parameters](#parameters-46)
|
|
178
192
|
* [createRepositoryGroup](#createrepositorygroup)
|
|
179
|
-
* [Parameters](#parameters-
|
|
193
|
+
* [Parameters](#parameters-47)
|
|
180
194
|
* [addRepositoryGroup](#addrepositorygroup)
|
|
181
|
-
* [Parameters](#parameters-
|
|
195
|
+
* [Parameters](#parameters-48)
|
|
182
196
|
* [NamedObject](#namedobject)
|
|
183
|
-
* [Parameters](#parameters-
|
|
197
|
+
* [Parameters](#parameters-49)
|
|
184
198
|
* [Properties](#properties-7)
|
|
185
199
|
* [equals](#equals-3)
|
|
186
|
-
* [Parameters](#parameters-
|
|
200
|
+
* [Parameters](#parameters-50)
|
|
187
201
|
* [displayName](#displayname)
|
|
188
|
-
* [update](#update)
|
|
189
202
|
* [toJSON](#tojson-2)
|
|
190
203
|
* [Project](#project)
|
|
191
|
-
* [Parameters](#parameters-
|
|
204
|
+
* [Parameters](#parameters-51)
|
|
192
205
|
* [PullRequest](#pullrequest)
|
|
193
|
-
* [Parameters](#parameters-
|
|
206
|
+
* [Parameters](#parameters-52)
|
|
194
207
|
* [Properties](#properties-8)
|
|
195
208
|
* [fullName](#fullname)
|
|
196
209
|
* [url](#url-2)
|
|
197
210
|
* [repository](#repository-1)
|
|
198
|
-
* [provider](#provider-
|
|
211
|
+
* [provider](#provider-2)
|
|
199
212
|
* [equals](#equals-4)
|
|
200
|
-
* [Parameters](#parameters-
|
|
213
|
+
* [Parameters](#parameters-53)
|
|
201
214
|
* [delete](#delete-1)
|
|
202
215
|
* [merge](#merge)
|
|
203
|
-
* [Parameters](#parameters-
|
|
216
|
+
* [Parameters](#parameters-54)
|
|
204
217
|
* [decline](#decline)
|
|
205
218
|
* [reviews](#reviews)
|
|
206
219
|
* [identifier](#identifier)
|
|
@@ -208,9 +221,9 @@ console.log(await readme.getString());
|
|
|
208
221
|
* [defaultListStates](#defaultliststates)
|
|
209
222
|
* [validMergeMethods](#validmergemethods)
|
|
210
223
|
* [list](#list-1)
|
|
211
|
-
* [Parameters](#parameters-
|
|
224
|
+
* [Parameters](#parameters-55)
|
|
212
225
|
* [open](#open)
|
|
213
|
-
* [Parameters](#parameters-
|
|
226
|
+
* [Parameters](#parameters-56)
|
|
214
227
|
* [title](#title)
|
|
215
228
|
* [body](#body)
|
|
216
229
|
* [state](#state)
|
|
@@ -220,20 +233,19 @@ console.log(await readme.getString());
|
|
|
220
233
|
* [ContentEntry](#contententry)
|
|
221
234
|
* [Properties](#properties-9)
|
|
222
235
|
* [Ref](#ref)
|
|
223
|
-
* [Parameters](#parameters-
|
|
236
|
+
* [Parameters](#parameters-57)
|
|
224
237
|
* [equals](#equals-5)
|
|
225
|
-
* [Parameters](#parameters-
|
|
238
|
+
* [Parameters](#parameters-58)
|
|
226
239
|
* [ref](#ref-1)
|
|
227
240
|
* [refId](#refid)
|
|
228
|
-
* [Parameters](#parameters-
|
|
241
|
+
* [Parameters](#parameters-59)
|
|
229
242
|
* [entries](#entries)
|
|
230
|
-
* [Parameters](#parameters-
|
|
243
|
+
* [Parameters](#parameters-60)
|
|
231
244
|
* [asyncIterator](#asynciterator)
|
|
232
245
|
* [maybeEntry](#maybeentry)
|
|
233
|
-
* [Parameters](#parameters-
|
|
246
|
+
* [Parameters](#parameters-61)
|
|
234
247
|
* [entry](#entry)
|
|
235
|
-
* [Parameters](#parameters-
|
|
236
|
-
* [provider](#provider-2)
|
|
248
|
+
* [Parameters](#parameters-62)
|
|
237
249
|
* [owner](#owner)
|
|
238
250
|
* [fullName](#fullname-1)
|
|
239
251
|
* [fullCondensedName](#fullcondensedname)
|
|
@@ -248,33 +260,28 @@ console.log(await readme.getString());
|
|
|
248
260
|
* [attributes](#attributes-1)
|
|
249
261
|
* [isProtected](#isprotected-1)
|
|
250
262
|
* [RepositoryGroup](#repositorygroup-1)
|
|
251
|
-
* [Parameters](#parameters-
|
|
263
|
+
* [Parameters](#parameters-63)
|
|
252
264
|
* [Properties](#properties-10)
|
|
253
|
-
* [repositoryClass](#repositoryclass-1)
|
|
254
|
-
* [branchClass](#branchclass-1)
|
|
255
|
-
* [contentClass](#contentclass)
|
|
256
|
-
* [pullRequestClass](#pullrequestclass-2)
|
|
257
|
-
* [hookClass](#hookclass-1)
|
|
258
265
|
* [attributeMapping](#attributemapping-1)
|
|
259
266
|
* [type](#type)
|
|
260
267
|
* [url](#url-3)
|
|
261
268
|
* [RepositoryOwner](#repositoryowner)
|
|
262
|
-
* [Parameters](#parameters-
|
|
269
|
+
* [Parameters](#parameters-64)
|
|
263
270
|
* [Repository](#repository-2)
|
|
264
|
-
* [Parameters](#parameters-
|
|
271
|
+
* [Parameters](#parameters-65)
|
|
265
272
|
* [Properties](#properties-11)
|
|
266
273
|
* [fullName](#fullname-2)
|
|
267
274
|
* [slug](#slug)
|
|
268
275
|
* [provider](#provider-3)
|
|
269
276
|
* [identifier](#identifier-2)
|
|
270
277
|
* [equals](#equals-6)
|
|
271
|
-
* [Parameters](#parameters-
|
|
278
|
+
* [Parameters](#parameters-66)
|
|
272
279
|
* [entry](#entry-1)
|
|
273
|
-
* [Parameters](#parameters-
|
|
280
|
+
* [Parameters](#parameters-67)
|
|
274
281
|
* [entries](#entries-1)
|
|
275
|
-
* [Parameters](#parameters-
|
|
282
|
+
* [Parameters](#parameters-68)
|
|
276
283
|
* [maybeEntry](#maybeentry-1)
|
|
277
|
-
* [Parameters](#parameters-
|
|
284
|
+
* [Parameters](#parameters-69)
|
|
278
285
|
* [urls](#urls)
|
|
279
286
|
* [url](#url-4)
|
|
280
287
|
* [cloneURL](#cloneurl)
|
|
@@ -285,46 +292,43 @@ console.log(await readme.getString());
|
|
|
285
292
|
* [isLocked](#islocked-1)
|
|
286
293
|
* [isDisabled](#isdisabled-1)
|
|
287
294
|
* [isTemplate](#istemplate)
|
|
288
|
-
* [branch](#branch-1)
|
|
289
|
-
* [Parameters](#parameters-67)
|
|
290
295
|
* [defaultBranch](#defaultbranch)
|
|
296
|
+
* [branch](#branch-1)
|
|
297
|
+
* [Parameters](#parameters-70)
|
|
291
298
|
* [branches](#branches-1)
|
|
292
|
-
* [Parameters](#parameters-
|
|
299
|
+
* [Parameters](#parameters-71)
|
|
293
300
|
* [createBranch](#createbranch-1)
|
|
294
|
-
* [Parameters](#parameters-
|
|
301
|
+
* [Parameters](#parameters-72)
|
|
295
302
|
* [addBranch](#addbranch)
|
|
296
|
-
* [Parameters](#parameters-
|
|
303
|
+
* [Parameters](#parameters-73)
|
|
297
304
|
* [deleteBranch](#deletebranch)
|
|
298
|
-
* [Parameters](#parameters-
|
|
299
|
-
* [tags](#tags-1)
|
|
300
|
-
* [Parameters](#parameters-72)
|
|
305
|
+
* [Parameters](#parameters-74)
|
|
301
306
|
* [tag](#tag)
|
|
302
|
-
* [Parameters](#parameters-
|
|
307
|
+
* [Parameters](#parameters-75)
|
|
308
|
+
* [tags](#tags-1)
|
|
309
|
+
* [Parameters](#parameters-76)
|
|
310
|
+
* [addTag](#addtag)
|
|
311
|
+
* [Parameters](#parameters-77)
|
|
303
312
|
* [delete](#delete-2)
|
|
304
313
|
* [createPullRequest](#createpullrequest-1)
|
|
305
|
-
* [Parameters](#parameters-
|
|
314
|
+
* [Parameters](#parameters-78)
|
|
306
315
|
* [addPullRequest](#addpullrequest)
|
|
307
|
-
* [Parameters](#parameters-
|
|
316
|
+
* [Parameters](#parameters-79)
|
|
308
317
|
* [pullRequests](#pullrequests-1)
|
|
309
318
|
* [pullRequest](#pullrequest-1)
|
|
310
|
-
* [Parameters](#parameters-
|
|
319
|
+
* [Parameters](#parameters-80)
|
|
311
320
|
* [deletePullRequest](#deletepullrequest)
|
|
312
|
-
* [Parameters](#parameters-
|
|
321
|
+
* [Parameters](#parameters-81)
|
|
313
322
|
* [addHook](#addhook)
|
|
314
|
-
* [Parameters](#parameters-
|
|
323
|
+
* [Parameters](#parameters-82)
|
|
315
324
|
* [createHook](#createhook)
|
|
316
|
-
* [Parameters](#parameters-
|
|
325
|
+
* [Parameters](#parameters-83)
|
|
317
326
|
* [hooks](#hooks-1)
|
|
318
327
|
* [hook](#hook-1)
|
|
319
|
-
* [Parameters](#parameters-
|
|
328
|
+
* [Parameters](#parameters-84)
|
|
320
329
|
* [type](#type-1)
|
|
321
330
|
* [refId](#refid-1)
|
|
322
|
-
* [Parameters](#parameters-
|
|
323
|
-
* [repositoryClass](#repositoryclass-2)
|
|
324
|
-
* [pullRequestClass](#pullrequestclass-3)
|
|
325
|
-
* [branchClass](#branchclass-2)
|
|
326
|
-
* [entryClass](#entryclass-2)
|
|
327
|
-
* [hookClass](#hookclass-2)
|
|
331
|
+
* [Parameters](#parameters-85)
|
|
328
332
|
* [toJSON](#tojson-3)
|
|
329
333
|
* [attributes](#attributes-2)
|
|
330
334
|
* [defaultBranchName](#defaultbranchname)
|
|
@@ -333,23 +337,23 @@ console.log(await readme.getString());
|
|
|
333
337
|
* [Review](#review)
|
|
334
338
|
* [SingleGroupProvider](#singlegroupprovider)
|
|
335
339
|
* [repository](#repository-3)
|
|
336
|
-
* [Parameters](#parameters-
|
|
340
|
+
* [Parameters](#parameters-86)
|
|
337
341
|
* [repositoryGroup](#repositorygroup-2)
|
|
338
|
-
* [Parameters](#parameters-
|
|
342
|
+
* [Parameters](#parameters-87)
|
|
339
343
|
* [repositoryGroups](#repositorygroups-1)
|
|
340
|
-
* [Parameters](#parameters-
|
|
344
|
+
* [Parameters](#parameters-88)
|
|
341
345
|
* [Tag](#tag-1)
|
|
342
|
-
* [Parameters](#parameters-
|
|
346
|
+
* [Parameters](#parameters-89)
|
|
343
347
|
* [refType](#reftype-1)
|
|
344
348
|
* [isWritable](#iswritable-1)
|
|
345
349
|
* [asArray](#asarray)
|
|
346
|
-
* [Parameters](#parameters-
|
|
350
|
+
* [Parameters](#parameters-90)
|
|
347
351
|
* [stripBaseName](#stripbasename)
|
|
348
|
-
* [Parameters](#parameters-
|
|
352
|
+
* [Parameters](#parameters-91)
|
|
349
353
|
* [stripBaseNames](#stripbasenames)
|
|
350
|
-
* [Parameters](#parameters-
|
|
354
|
+
* [Parameters](#parameters-92)
|
|
351
355
|
* [generateBranchName](#generatebranchname)
|
|
352
|
-
* [Parameters](#parameters-
|
|
356
|
+
* [Parameters](#parameters-93)
|
|
353
357
|
|
|
354
358
|
## Application
|
|
355
359
|
|
|
@@ -483,6 +487,10 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
|
|
|
483
487
|
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
484
488
|
* `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
485
489
|
|
|
490
|
+
### update
|
|
491
|
+
|
|
492
|
+
Save object attributes in the backing store.
|
|
493
|
+
|
|
486
494
|
### equals
|
|
487
495
|
|
|
488
496
|
Check for equality
|
|
@@ -493,6 +501,72 @@ Check for equality
|
|
|
493
501
|
|
|
494
502
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if other is present
|
|
495
503
|
|
|
504
|
+
### provider
|
|
505
|
+
|
|
506
|
+
The provider we live in.
|
|
507
|
+
|
|
508
|
+
Returns **[BaseProvider](#baseprovider)**
|
|
509
|
+
|
|
510
|
+
### info
|
|
511
|
+
|
|
512
|
+
Forwarded to the owner.
|
|
513
|
+
|
|
514
|
+
#### Parameters
|
|
515
|
+
|
|
516
|
+
* `args` **...any**
|
|
517
|
+
|
|
518
|
+
### warn
|
|
519
|
+
|
|
520
|
+
Forwarded to the owner.
|
|
521
|
+
|
|
522
|
+
#### Parameters
|
|
523
|
+
|
|
524
|
+
* `args` **...any**
|
|
525
|
+
|
|
526
|
+
### error
|
|
527
|
+
|
|
528
|
+
Forwarded to the owner.
|
|
529
|
+
|
|
530
|
+
#### Parameters
|
|
531
|
+
|
|
532
|
+
* `args` **...any**
|
|
533
|
+
|
|
534
|
+
### repositoryClass
|
|
535
|
+
|
|
536
|
+
By default we use the owners implementation.
|
|
537
|
+
|
|
538
|
+
Returns **Class** as defined in the owner
|
|
539
|
+
|
|
540
|
+
### pullRequestClass
|
|
541
|
+
|
|
542
|
+
By default we use the owners implementation.
|
|
543
|
+
|
|
544
|
+
Returns **Class** as defined in the owner
|
|
545
|
+
|
|
546
|
+
### branchClass
|
|
547
|
+
|
|
548
|
+
By default we use the owners implementation.
|
|
549
|
+
|
|
550
|
+
Returns **Class** as defined in the owner
|
|
551
|
+
|
|
552
|
+
### tagClass
|
|
553
|
+
|
|
554
|
+
By default we use the owners implementation.
|
|
555
|
+
|
|
556
|
+
Returns **Class** as defined in the owner
|
|
557
|
+
|
|
558
|
+
### entryClass
|
|
559
|
+
|
|
560
|
+
By default we use the owners implementation.
|
|
561
|
+
|
|
562
|
+
Returns **Class** as defined in the owner
|
|
563
|
+
|
|
564
|
+
### hookClass
|
|
565
|
+
|
|
566
|
+
By default we use the owners implementation.
|
|
567
|
+
|
|
568
|
+
Returns **Class** as defined in the owner
|
|
569
|
+
|
|
496
570
|
### attributes
|
|
497
571
|
|
|
498
572
|
Attributes definitions
|
|
@@ -766,6 +840,10 @@ Returns **Class** repository class used by the Provider
|
|
|
766
840
|
|
|
767
841
|
Returns **Class** branch class used by the Provider
|
|
768
842
|
|
|
843
|
+
### tagClass
|
|
844
|
+
|
|
845
|
+
Returns **Class** branch class used by the Provider
|
|
846
|
+
|
|
769
847
|
### entryClass
|
|
770
848
|
|
|
771
849
|
Returns **Class** entry class used by the Provider
|
|
@@ -924,6 +1002,7 @@ Add commits into a pull request.
|
|
|
924
1002
|
* `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
|
|
925
1003
|
* `options.skipWithoutCommits` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a PR if no commits are given
|
|
926
1004
|
* `options.bodyFromCommitMessages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** generate body from commit messages
|
|
1005
|
+
* `options.body` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** body of the PR
|
|
927
1006
|
|
|
928
1007
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
|
|
929
1008
|
|
|
@@ -952,12 +1031,6 @@ Create a pull request.
|
|
|
952
1031
|
|
|
953
1032
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
|
|
954
1033
|
|
|
955
|
-
### pullRequestClass
|
|
956
|
-
|
|
957
|
-
By default we use the repository implementation.
|
|
958
|
-
|
|
959
|
-
Returns **Class** as defined in the repository
|
|
960
|
-
|
|
961
1034
|
### createBranch
|
|
962
1035
|
|
|
963
1036
|
Create a new [Branch](#branch) by cloning a given source branch.
|
|
@@ -1118,10 +1191,6 @@ Beatified name use for human displaying only.
|
|
|
1118
1191
|
|
|
1119
1192
|
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
|
|
1120
1193
|
|
|
1121
|
-
### update
|
|
1122
|
-
|
|
1123
|
-
Save object attributes in the backing store.
|
|
1124
|
-
|
|
1125
1194
|
### toJSON
|
|
1126
1195
|
|
|
1127
1196
|
Provide name and all defined attributes.
|
|
@@ -1392,12 +1461,6 @@ Get exactly one matching entry by name (throws if entry is not found).
|
|
|
1392
1461
|
|
|
1393
1462
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
|
|
1394
1463
|
|
|
1395
|
-
### provider
|
|
1396
|
-
|
|
1397
|
-
The provider we live in.
|
|
1398
|
-
|
|
1399
|
-
Returns **[BaseProvider](#baseprovider)**
|
|
1400
|
-
|
|
1401
1464
|
### owner
|
|
1402
1465
|
|
|
1403
1466
|
* **See**: [Repository#owner](Repository#owner)
|
|
@@ -1494,36 +1557,6 @@ Abstract repository collection.
|
|
|
1494
1557
|
* `provider` **[BaseProvider](#baseprovider)**
|
|
1495
1558
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1496
1559
|
|
|
1497
|
-
### repositoryClass
|
|
1498
|
-
|
|
1499
|
-
By default we use the providers implementation.
|
|
1500
|
-
|
|
1501
|
-
Returns **Class** as defined in the provider
|
|
1502
|
-
|
|
1503
|
-
### branchClass
|
|
1504
|
-
|
|
1505
|
-
By default we use the providers implementation.
|
|
1506
|
-
|
|
1507
|
-
Returns **Class** as defined in the provider
|
|
1508
|
-
|
|
1509
|
-
### contentClass
|
|
1510
|
-
|
|
1511
|
-
By default we use the providers implementation.
|
|
1512
|
-
|
|
1513
|
-
Returns **Class** as defined in the provider
|
|
1514
|
-
|
|
1515
|
-
### pullRequestClass
|
|
1516
|
-
|
|
1517
|
-
By default we use the providers implementation.
|
|
1518
|
-
|
|
1519
|
-
Returns **Class** as defined in the provider
|
|
1520
|
-
|
|
1521
|
-
### hookClass
|
|
1522
|
-
|
|
1523
|
-
By default we use the providers implementation.
|
|
1524
|
-
|
|
1525
|
-
Returns **Class** as defined in the provider
|
|
1526
|
-
|
|
1527
1560
|
### attributeMapping
|
|
1528
1561
|
|
|
1529
1562
|
Map attributes between external and internal representation.
|
|
@@ -1697,6 +1730,12 @@ By default we are not a template.
|
|
|
1697
1730
|
|
|
1698
1731
|
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
|
|
1699
1732
|
|
|
1733
|
+
### defaultBranch
|
|
1734
|
+
|
|
1735
|
+
Lookup the default branch.
|
|
1736
|
+
|
|
1737
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** branch named after defaultBranchName
|
|
1738
|
+
|
|
1700
1739
|
### branch
|
|
1701
1740
|
|
|
1702
1741
|
Lookup branch by name.
|
|
@@ -1707,12 +1746,6 @@ Lookup branch by name.
|
|
|
1707
1746
|
|
|
1708
1747
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>**
|
|
1709
1748
|
|
|
1710
|
-
### defaultBranch
|
|
1711
|
-
|
|
1712
|
-
Lookup the default branch.
|
|
1713
|
-
|
|
1714
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** branch named after defaultBranchName
|
|
1715
|
-
|
|
1716
1749
|
### branches
|
|
1717
1750
|
|
|
1718
1751
|
#### Parameters
|
|
@@ -1743,7 +1776,7 @@ Internal branch creation does not call repository.initialize()
|
|
|
1743
1776
|
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch
|
|
1744
1777
|
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
1745
1778
|
|
|
1746
|
-
Returns **[
|
|
1779
|
+
Returns **[Branch](#branch)** newly created branch
|
|
1747
1780
|
|
|
1748
1781
|
### deleteBranch
|
|
1749
1782
|
|
|
@@ -1755,6 +1788,16 @@ Delete a [Branch](#branch).
|
|
|
1755
1788
|
|
|
1756
1789
|
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
|
|
1757
1790
|
|
|
1791
|
+
### tag
|
|
1792
|
+
|
|
1793
|
+
Get a Tag.
|
|
1794
|
+
|
|
1795
|
+
#### Parameters
|
|
1796
|
+
|
|
1797
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1798
|
+
|
|
1799
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>**
|
|
1800
|
+
|
|
1758
1801
|
### tags
|
|
1759
1802
|
|
|
1760
1803
|
#### Parameters
|
|
@@ -1763,15 +1806,17 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
|
1763
1806
|
|
|
1764
1807
|
Returns **AsyncIterator<[Tag](#tag)>** of all tags
|
|
1765
1808
|
|
|
1766
|
-
###
|
|
1809
|
+
### addTag
|
|
1767
1810
|
|
|
1768
|
-
|
|
1811
|
+
Add a new [Tag](#tag).
|
|
1812
|
+
Internal tag creation does not call repository.initialize()
|
|
1769
1813
|
|
|
1770
1814
|
#### Parameters
|
|
1771
1815
|
|
|
1772
|
-
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
|
|
1816
|
+
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new tag
|
|
1817
|
+
* `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
|
|
1773
1818
|
|
|
1774
|
-
Returns **[
|
|
1819
|
+
Returns **[Tag](#tag)** newly created tag
|
|
1775
1820
|
|
|
1776
1821
|
### delete
|
|
1777
1822
|
|
|
@@ -1878,36 +1923,6 @@ Get sha of a ref.
|
|
|
1878
1923
|
|
|
1879
1924
|
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
|
|
1880
1925
|
|
|
1881
|
-
### repositoryClass
|
|
1882
|
-
|
|
1883
|
-
By default we use the owners implementation.
|
|
1884
|
-
|
|
1885
|
-
Returns **Class** as defined in the owner
|
|
1886
|
-
|
|
1887
|
-
### pullRequestClass
|
|
1888
|
-
|
|
1889
|
-
By default we use the owners implementation.
|
|
1890
|
-
|
|
1891
|
-
Returns **Class** as defined in the owner
|
|
1892
|
-
|
|
1893
|
-
### branchClass
|
|
1894
|
-
|
|
1895
|
-
By default we use the owners implementation.
|
|
1896
|
-
|
|
1897
|
-
Returns **Class** as defined in the owner
|
|
1898
|
-
|
|
1899
|
-
### entryClass
|
|
1900
|
-
|
|
1901
|
-
By default we use the owners implementation.
|
|
1902
|
-
|
|
1903
|
-
Returns **Class** as defined in the owner
|
|
1904
|
-
|
|
1905
|
-
### hookClass
|
|
1906
|
-
|
|
1907
|
-
By default we use the owners implementation.
|
|
1908
|
-
|
|
1909
|
-
Returns **Class** as defined in the owner
|
|
1910
|
-
|
|
1911
1926
|
### toJSON
|
|
1912
1927
|
|
|
1913
1928
|
Provide name and all defined attributes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "repository-provider",
|
|
3
|
-
"version": "26.4.
|
|
3
|
+
"version": "26.4.1",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -36,9 +36,9 @@
|
|
|
36
36
|
"ava": "^4.0.1",
|
|
37
37
|
"c8": "^7.11.0",
|
|
38
38
|
"documentation": "^13.2.5",
|
|
39
|
-
"repository-provider-test-support": "^1.9.
|
|
39
|
+
"repository-provider-test-support": "^1.9.9",
|
|
40
40
|
"semantic-release": "^19.0.2",
|
|
41
|
-
"typescript": "^4.6.0-dev.
|
|
41
|
+
"typescript": "^4.6.0-dev.20220125"
|
|
42
42
|
},
|
|
43
43
|
"engines": {
|
|
44
44
|
"node": ">=14.18.3"
|
package/src/branch.mjs
CHANGED
|
@@ -157,14 +157,6 @@ export class Branch extends Ref {
|
|
|
157
157
|
*/
|
|
158
158
|
async removeEntries(entries) {}
|
|
159
159
|
|
|
160
|
-
/**
|
|
161
|
-
* By default we use the providers implementation.
|
|
162
|
-
* @return {Class} as defined in the repository
|
|
163
|
-
*/
|
|
164
|
-
get entryClass() {
|
|
165
|
-
return this.repository.entryClass;
|
|
166
|
-
}
|
|
167
|
-
|
|
168
160
|
/**
|
|
169
161
|
* Create a pull request.
|
|
170
162
|
* @param {Branch} toBranch
|