github-repository-provider 9.0.10 → 9.0.11

package/README.md

@@ -42,13 +42,15 @@ console.log(entry.name);
         *   [Parameters](#parameters-2)
     *   [entry](#entry)
         *   [Parameters](#parameters-3)
-    *   [removeEntries](#removeentries)
+    *   [entries](#entries)
         *   [Parameters](#parameters-4)
+    *   [removeEntries](#removeentries)
+        *   [Parameters](#parameters-5)
 *   [GithubOwner](#githubowner)
     *   [createRepository](#createrepository)
-        *   [Parameters](#parameters-5)
-    *   [deleteRepository](#deleterepository)
         *   [Parameters](#parameters-6)
+    *   [deleteRepository](#deleterepository)
+        *   [Parameters](#parameters-7)
     *   [attributeMapping](#attributemapping)
 *   [GithubProvider](#githubprovider)
     *   [Examples](#examples)
@@ -58,23 +60,23 @@ console.log(entry.name);
     *   [instanceIdentifier](#instanceidentifier)
 *   [GithubPullRequest](#githubpullrequest)
     *   [\_merge](#_merge)
-        *   [Parameters](#parameters-7)
+        *   [Parameters](#parameters-8)
     *   [update](#update)
     *   [validMergeMethods](#validmergemethods)
     *   [list](#list)
-        *   [Parameters](#parameters-8)
-    *   [open](#open)
         *   [Parameters](#parameters-9)
+    *   [open](#open)
+        *   [Parameters](#parameters-10)
 *   [GithubRepository](#githubrepository)
     *   [defaultBranchName](#defaultbranchname)
     *   [commits](#commits)
-        *   [Parameters](#parameters-10)
-    *   [commitForSha](#commitforsha)
         *   [Parameters](#parameters-11)
-    *   [tree](#tree)
+    *   [commitForSha](#commitforsha)
         *   [Parameters](#parameters-12)
-    *   [addTree](#addtree)
+    *   [tree](#tree)
         *   [Parameters](#parameters-13)
+    *   [addTree](#addtree)
+        *   [Parameters](#parameters-14)
     *   [initializeBranches](#initializebranches)
     *   [initializeTags](#initializetags)
     *   [url](#url)
@@ -83,13 +85,13 @@ console.log(entry.name);
     *   [api](#api)
     *   [update](#update-1)
     *   [refId](#refid)
-        *   [Parameters](#parameters-14)
-    *   [\_setRefId](#_setrefid)
         *   [Parameters](#parameters-15)
-    *   [setRefId](#setrefid)
+    *   [\_setRefId](#_setrefid)
         *   [Parameters](#parameters-16)
-    *   [deletePullRequest](#deletepullrequest)
+    *   [setRefId](#setrefid)
         *   [Parameters](#parameters-17)
+    *   [deletePullRequest](#deletepullrequest)
+        *   [Parameters](#parameters-18)
     *   [initializeHooks](#initializehooks)
 
 ## GithubBranch
@@ -135,13 +137,21 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+### entries
+
+#### Parameters
+
+*   `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;
+
+Returns **AsyncGenerator\<ContentEntry>** all matching entries in the branch
+
 ### removeEntries
 
 <https://developer.github.com/v3/repos/contents/>
 
 #### Parameters
 
-*   `entries` **AsyncIterator\<ContentEntry>**&#x20;
+*   `entries` **AsyncIterable\<ContentEntry>**&#x20;
 
 ## GithubOwner
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-repository-provider",
-  "version": "9.0.10",
+  "version": "9.0.11",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -37,25 +37,25 @@
   "dependencies": {
     "content-entry": "^11.0.0",
     "fetch-link-util": "^1.1.1",
-    "fetch-rate-limit-util": "^4.2.2",
+    "fetch-rate-limit-util": "^4.3.1",
     "matching-iterator": "^2.1.3",
     "one-time-execution-method": "^3.1.1",
     "repository-provider": "^35.2.15"
   },
   "devDependencies": {
-    "@types/node": "^20.11.26",
-    "ava": "^6.1.2",
+    "@types/node": "^20.12.11",
+    "ava": "^6.1.3",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
     "etag-cache-leveldb": "^2.1.1",
     "leveldown": "^6.1.1",
     "levelup": "^5.1.1",
     "repository-provider-test-support": "^3.1.4",
-    "semantic-release": "^23.0.2",
-    "typescript": "^5.4.2"
+    "semantic-release": "^23.1.1",
+    "typescript": "^5.4.5"
   },
   "engines": {
-    "node": ">=20.11.1"
+    "node": ">=20.12.2"
   },
   "repository": {
     "type": "git",

package/src/github-branch.mjs

@@ -102,6 +102,11 @@ export class GithubBranch extends Branch {
     return p;
   }
 
+  /**
+   * 
+   * @param {string[]|string} patterns
+   * @return {AsyncGenerator<ContentEntry>} all matching entries in the branch
+   */
   async *entries(patterns) {
     const commit = await this.owner.commitForSha(await this.refId);
 
@@ -139,7 +144,7 @@ export class GithubBranch extends Branch {
 
   /**
    * https://developer.github.com/v3/repos/contents/
-   * @param {AsyncIterator<ContentEntry>} entries
+   * @param {AsyncIterable<ContentEntry>} entries
    */
   async removeEntries(entries) {
     for await (const entry of entries) {

package/types/github-branch.d.mts

@@ -24,46 +24,18 @@ export class GithubBranch extends Branch {
      * @param {string} name
      */
     entry(name: string): Promise<any>;
-    entries(patterns: any): AsyncGenerator<CollectionEntry | LazyBufferContentEntry, void, unknown>;
+    /**
+     *
+     * @param {string[]|string} patterns
+     * @return {AsyncGenerator<ContentEntry>} all matching entries in the branch
+     */
+    entries(patterns: string[] | string): AsyncGenerator<ContentEntry>;
     /**
      * https://developer.github.com/v3/repos/contents/
-     * @param {AsyncIterator<ContentEntry>} entries
+     * @param {AsyncIterable<ContentEntry>} entries
      */
-    removeEntries(entries: AsyncIterator<ContentEntry>): Promise<void>;
+    removeEntries(entries: AsyncIterable<ContentEntry>): Promise<void>;
     #private;
 }
 import { Branch } from "repository-provider";
 import { ContentEntry } from "content-entry";
-import { CollectionEntry } from "content-entry";
-declare const LazyBufferContentEntry_base: new (name: string) => {
-    readonly string: string;
-    readonly readStream: ReadableStream<any>;
-    readonly isEmpty: boolean;
-    readonly size: number;
-    getReadStream(): Promise<ReadableStream<any>>;
-    readonly isBlob: boolean;
-    readonly types: string[];
-    readonly buffer: Uint8Array;
-    readonly encoding: string;
-    equalsContent(other: ContentEntry): Promise<boolean>;
-    name: string;
-    readonly isCollection: boolean;
-    readonly mode: number;
-    readonly mtime: Date;
-    readonly isDeleted: boolean;
-    readonly isExistent: boolean;
-    toJSON(): {
-        name: string;
-        isBlob: boolean;
-        isCollection: boolean;
-    };
-    equals(other: import("content-entry").BaseEntry): Promise<boolean>;
-};
-declare class LazyBufferContentEntry extends LazyBufferContentEntry_base {
-    constructor(name: any, mode: any, branch: any);
-    branch: any;
-    get buffer(): Promise<any>;
-    getBuffer(): Promise<any>;
-    #private;
-}
-export {};

package/types/github-provider.d.mts

@@ -152,8 +152,8 @@ export class GithubProvider extends MultiGroupProvider {
             env?: string | string[];
         };
     };
-    fetch(url: any, options?: {}): any;
-    fetchJSON(url: any, options?: {}): any;
+    fetch(url: any, options?: {}): Promise<Response>;
+    fetchJSON(url: any, options?: {}): Promise<Response>;
     /**
      * {@link https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user}
      */