bitbucket-repository-provider 5.1.6 → 5.1.8

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 CHANGED
@@ -96,7 +96,7 @@ Commit entries
96
96
 
97
97
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
98
98
  * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
99
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
99
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
100
100
 
101
101
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**&#x20;
102
102
 
@@ -225,7 +225,7 @@ Result will be filtered by source branch, destination branch and states
225
225
  * `filter.destination` **Branch?**&#x20;
226
226
  * `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;
227
227
 
228
- Returns **Iterator\<PullRequest>**&#x20;
228
+ Returns **AsyncIterator\<PullRequest>**&#x20;
229
229
 
230
230
  ### open
231
231
 
@@ -248,9 +248,9 @@ Returns **Iterator\<PullRequest>**&#x20;
248
248
  #### Parameters
249
249
 
250
250
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
251
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
251
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
252
252
 
253
- Returns **Repository** newly created repository
253
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Repository>** newly created repository
254
254
 
255
255
  ## BitbucketRepository
256
256
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bitbucket-repository-provider",
3
- "version": "5.1.6",
3
+ "version": "5.1.8",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -30,17 +30,17 @@
30
30
  },
31
31
  "dependencies": {
32
32
  "content-entry": "^8.0.1",
33
- "fetch-rate-limit-util": "^4.0.2",
33
+ "fetch-rate-limit-util": "^4.0.3",
34
34
  "matching-iterator": "^2.0.12",
35
35
  "one-time-execution-method": "^3.0.6",
36
- "repository-provider": "^32.7.17"
36
+ "repository-provider": "^32.7.23"
37
37
  },
38
38
  "devDependencies": {
39
- "ava": "^5.2.0",
40
- "c8": "^7.13.0",
41
- "documentation": "^14.0.1",
42
- "repository-provider-test-support": "^2.3.5",
43
- "semantic-release": "^21.0.2"
39
+ "ava": "^5.3.0",
40
+ "c8": "^8.0.0",
41
+ "documentation": "^14.0.2",
42
+ "repository-provider-test-support": "^2.3.8",
43
+ "semantic-release": "^21.0.5"
44
44
  },
45
45
  "engines": {
46
46
  "node": ">=18.16.0"
@@ -82,7 +82,7 @@ export class BitbucketBranch extends Branch {
82
82
  * Commit entries
83
83
  * @param {string} message commit message
84
84
  * @param {ContentEntry[]} updates content to be commited
85
- * @param {Object} options
85
+ * @param {Object} [options]
86
86
  * @return {Promise}
87
87
  */
88
88
  async commit(message, updates, options) {
@@ -31,10 +31,10 @@ export class BitbucketPullRequest extends PullRequest {
31
31
  * Result will be filtered by source branch, destination branch and states
32
32
  * @param {Repository} repository
33
33
  * @param {Object} filter
34
- * @param {Branch?} filter.source
35
- * @param {Branch?} filter.destination
36
- * @param {Set<string>?} filter.states
37
- * @return {Iterator<PullRequest>}
34
+ * @param {Branch} [filter.source]
35
+ * @param {Branch} [filter.destination]
36
+ * @param {Set<string>} [filter.states]
37
+ * @return {AsyncIterator<PullRequest>}
38
38
  */
39
39
  static async *list(repository, filter = {}) {
40
40
  const getBranch = async u =>
@@ -24,8 +24,8 @@ export class BitbucketRepositoryGroup extends RepositoryGroup {
24
24
  /**
25
25
  * {@link https://community.atlassian.com/t5/Bitbucket-articles/Create-and-configure-a-Bitbucket-Server-repository-using-the/ba-p/828364}
26
26
  * @param {string} name
27
- * @param {Object} options
28
- * @return {Repository} newly created repository
27
+ * @param {Object} [options]
28
+ * @return {Promise<Repository>} newly created repository
29
29
  */
30
30
  async createRepository(name, options) {
31
31
  const response = await this.provider.fetch(