github-repository-provider 9.0.1 → 9.0.3

package/README.md

@@ -161,7 +161,7 @@ Represents github repo owner either
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
 
-Returns **Repository** newly created repository
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Repository>** newly created repository
 
 ### deleteRepository
 
@@ -288,7 +288,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 
-Returns **AsyncIterator\<Commit>**&#x20;
+Returns **AsyncIterable\<Commit>**&#x20;
 
 ### commitForSha
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-repository-provider",
-  "version": "9.0.1",
+  "version": "9.0.3",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -45,7 +45,7 @@
     "ava": "^6.1.1",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "etag-cache-leveldb": "^2.1.0",
+    "etag-cache-leveldb": "^2.1.1",
     "leveldown": "^6.1.1",
     "levelup": "^5.1.1",
     "repository-provider-test-support": "^3.1.2",

package/src/github-owner.mjs

@@ -1,4 +1,4 @@
-import { RepositoryGroup } from "repository-provider";
+import { RepositoryGroup, Repository } from "repository-provider";
 
 /**
  * Represents github repo owner either
@@ -26,7 +26,7 @@ export class GithubOwner extends RepositoryGroup {
    * {@link https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user}
    * @param {string} name
    * @param {Object} options
-   * @return {Repository} newly created repository
+   * @return {Promise<Repository>} newly created repository
    */
   async createRepository(name, options = {}) {
     const response = await this.provider.fetch(`${this.api}/repos`, {

package/src/github-pull-request.mjs

@@ -1,4 +1,9 @@
-import { PullRequest, boolean_attribute } from "repository-provider";
+import {
+  PullRequest,
+  Repository,
+  Branch,
+  boolean_attribute
+} from "repository-provider";
 import { getHeaderLink } from "fetch-link-util";
 
 /**

package/src/github-repository.mjs

@@ -7,7 +7,8 @@ import {
   language_attribute,
   default_attribute,
   mapAttributesInverse,
-  optionJSON
+  optionJSON,
+  Commit
 } from "repository-provider";
 import { getHeaderLink } from "fetch-link-util";
 import { defaultStateActions, errorHandler } from "fetch-rate-limit-util";
@@ -70,7 +71,7 @@ export class GithubRepository extends Repository {
   /**
    * {@link https://docs.github.com/en/rest/reference/commits#list-commits}
    * @param {Object} options
-   * @returns {AsyncIterator<Commit>}
+   * @returns {AsyncIterable<Commit>}
    */
   async *commits(options) {
     let next = `${this.api}/commits`;