github-repository-provider 7.32.0 → 7.32.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.
Files changed (2) hide show
  1. package/README.md +35 -35
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -56,7 +56,7 @@ console.log(entry.name);
56
56
  * [name](#name)
57
57
  * [instanceIdentifier](#instanceidentifier)
58
58
  * [GithubPullRequest](#githubpullrequest)
59
- * [\_merge](#\_merge)
59
+ * [\_merge](#_merge)
60
60
  * [Parameters](#parameters-7)
61
61
  * [update](#update)
62
62
  * [validMergeMethods](#validmergemethods)
@@ -83,7 +83,7 @@ console.log(entry.name);
83
83
  * [update](#update-1)
84
84
  * [refId](#refid)
85
85
  * [Parameters](#parameters-14)
86
- * [\_setRefId](#\_setrefid)
86
+ * [\_setRefId](#_setrefid)
87
87
  * [Parameters](#parameters-15)
88
88
  * [setRefId](#setrefid)
89
89
  * [Parameters](#parameters-16)
@@ -99,9 +99,9 @@ Branch on GitHub.
99
99
 
100
100
  ### Parameters
101
101
 
102
- * `owner`
103
- * `name`
104
- * `options`
102
+ * `owner`  
103
+ * `name`  
104
+ * `options`  
105
105
 
106
106
  ### writeEntry
107
107
 
@@ -110,7 +110,7 @@ Writes content into the branch
110
110
 
111
111
  #### Parameters
112
112
 
113
- * `entry` **ConentEntry**
113
+ * `entry` **ConentEntry** 
114
114
 
115
115
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>** written content with sha values set
116
116
 
@@ -122,9 +122,9 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
122
122
 
123
123
  #### Parameters
124
124
 
125
- * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
126
- * `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>**
127
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
125
+ * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
126
+ * `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>**&#x20;
127
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
128
128
 
129
129
  ### entry
130
130
 
@@ -132,7 +132,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
132
132
 
133
133
  #### Parameters
134
134
 
135
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
135
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
136
136
 
137
137
  ### removeEntries
138
138
 
@@ -140,7 +140,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
140
140
 
141
141
  #### Parameters
142
142
 
143
- * `entries` **Iterator\<ContentEntry>**
143
+ * `entries` **Iterator\<ContentEntry>**&#x20;
144
144
 
145
145
  ## GithubOwner
146
146
 
@@ -157,7 +157,7 @@ Represents github repo owner either
157
157
 
158
158
  #### Parameters
159
159
 
160
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
160
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
161
161
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
162
162
 
163
163
  Returns **Repository** newly created repository
@@ -168,7 +168,7 @@ Returns **Repository** newly created repository
168
168
 
169
169
  #### Parameters
170
170
 
171
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
171
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
172
172
 
173
173
  ### attributeMapping
174
174
 
@@ -184,7 +184,7 @@ GitHub provider.
184
184
  Lookup a repository.
185
185
  known environment variables
186
186
 
187
- * GITHUB_TOKEN or GH_TOKEN api token
187
+ * GITHUB\_TOKEN or GH\_TOKEN api token
188
188
 
189
189
  ### Examples
190
190
 
@@ -256,7 +256,7 @@ Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
256
256
 
257
257
  #### Parameters
258
258
 
259
- * `repository` **Repository**
259
+ * `repository` **Repository**&#x20;
260
260
  * `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
261
261
 
262
262
  ### open
@@ -265,9 +265,9 @@ Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
265
265
 
266
266
  #### Parameters
267
267
 
268
- * `source` **Branch**
269
- * `destination` **Branch**
270
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
268
+ * `source` **Branch**&#x20;
269
+ * `destination` **Branch**&#x20;
270
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
271
271
 
272
272
  ## GithubRepository
273
273
 
@@ -285,9 +285,9 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
285
285
 
286
286
  #### Parameters
287
287
 
288
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
288
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
289
289
 
290
- Returns **AsyncIterator\<Commit>**
290
+ Returns **AsyncIterator\<Commit>**&#x20;
291
291
 
292
292
  ### commitForSha
293
293
 
@@ -295,7 +295,7 @@ Returns **AsyncIterator\<Commit>**
295
295
 
296
296
  #### Parameters
297
297
 
298
- * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
298
+ * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
299
299
 
300
300
  Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** response
301
301
 
@@ -305,9 +305,9 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
305
305
 
306
306
  #### Parameters
307
307
 
308
- * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
308
+ * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
309
309
 
310
- Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**
310
+ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**&#x20;
311
311
 
312
312
  ### addTree
313
313
 
@@ -315,7 +315,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
315
315
 
316
316
  #### Parameters
317
317
 
318
- * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**
318
+ * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**&#x20;
319
319
  * `base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base tree sha
320
320
 
321
321
  Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** newly created tree
@@ -336,19 +336,19 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
336
336
 
337
337
  Deliver the url of issue tracking system.
338
338
 
339
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
339
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
340
340
 
341
341
  ### homePageURL
342
342
 
343
343
  Deliver the url of the repositories home page.
344
344
 
345
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
345
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
346
346
 
347
347
  ### api
348
348
 
349
349
  API endpoint for ourselfs.
350
350
 
351
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
351
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
352
352
 
353
353
  ### update
354
354
 
@@ -361,7 +361,7 @@ Get sha of a ref.
361
361
 
362
362
  #### Parameters
363
363
 
364
- * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
364
+ * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
365
365
 
366
366
  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
367
367
 
@@ -369,8 +369,8 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
369
369
 
370
370
  #### Parameters
371
371
 
372
- * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
373
- * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
372
+ * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
373
+ * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
374
374
 
375
375
  ### setRefId
376
376
 
@@ -378,11 +378,11 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
378
378
 
379
379
  #### Parameters
380
380
 
381
- * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
382
- * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
383
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
381
+ * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
382
+ * `sha` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
383
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
384
384
 
385
- Returns **any**
385
+ Returns **any**&#x20;
386
386
 
387
387
  ### deletePullRequest
388
388
 
@@ -390,7 +390,7 @@ Returns **any**
390
390
 
391
391
  #### Parameters
392
392
 
393
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
393
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
394
394
 
395
395
  ### initializeHooks
396
396
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "github-repository-provider",
3
- "version": "7.32.0",
3
+ "version": "7.32.1",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -30,23 +30,23 @@
30
30
  "lint:docs": "documentation lint ./src/**/*.mjs"
31
31
  },
32
32
  "dependencies": {
33
- "content-entry": "^5.2.3",
34
- "fetch-link-util": "^1.0.11",
33
+ "content-entry": "^5.2.5",
34
+ "fetch-link-util": "^1.0.12",
35
35
  "fetch-rate-limit-util": "^3.0.16",
36
- "matching-iterator": "^2.0.7",
36
+ "matching-iterator": "^2.0.8",
37
37
  "node-fetch": "^3.2.10",
38
38
  "one-time-execution-method": "^3.0.4",
39
- "repository-provider": "^32.0.6"
39
+ "repository-provider": "^32.1.0"
40
40
  },
41
41
  "devDependencies": {
42
- "ava": "^4.3.1",
42
+ "ava": "^4.3.3",
43
43
  "c8": "^7.12.0",
44
44
  "documentation": "^14.0.0",
45
45
  "etag-cache-leveldb": "^1.3.0",
46
46
  "leveldown": "^6.1.1",
47
47
  "levelup": "^5.1.1",
48
48
  "repository-provider-test-support": "^2.2.13",
49
- "semantic-release": "^19.0.3"
49
+ "semantic-release": "^19.0.5"
50
50
  },
51
51
  "engines": {
52
52
  "node": ">=16.17.0"