repository-provider 35.2.12 → 35.2.13

package/README.md

@@ -639,7 +639,7 @@ Takes values from options.
 
 #### Parameters
 
-*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
 *   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
 
 ### update
@@ -930,9 +930,10 @@ Creates a new provider for a given set of options.
 
 #### Parameters
 
-*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options (optional, default `{}`)
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options
 
     *   `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
+    *   `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
 
 Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** newly created provider or undefined if options are not sufficient to construct a provider
@@ -1178,9 +1179,10 @@ Creates a new provider for a given set of options.
 
 #### Parameters
 
-*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options (optional, default `{}`)
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options
 
     *   `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
+    *   `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
 
 Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** newly created provider or undefined if options are not sufficient to construct a provider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "35.2.12",
+  "version": "35.2.13",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/base-provider.mjs

@@ -316,6 +316,7 @@ export class BaseProvider extends BaseObject {
    *
    * @param {string} type name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
    * @param {string[]|string|undefined} patterns group / repository filter
+   * @return {AsyncIterable<Repository|PullRequest|Branch|Tag|Project|Milestone|Hook>} all matching repositories of the providers
    */
   async *list(type, patterns) {
     if (patterns === undefined) {
@@ -325,6 +326,7 @@ export class BaseProvider extends BaseObject {
       }
     } else {
       for (const pattern of asArray(patterns)) {
+        // @ts-ignore
         const [groupPattern, repoPattern] = stripBaseName(
           pattern,
           this.repositoryBases
@@ -344,6 +346,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterator<Project>} all matching projects of the provider
    */
   async *projects(patterns) {
+    // @ts-ignore
     yield* this.list("projects", patterns);
   }
 
@@ -353,6 +356,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterator<Milestone>} all matching milestones of the provider
    */
   async *milestones(patterns) {
+    // @ts-ignore
     yield* this.list("milestones", patterns);
   }
 
@@ -362,6 +366,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Repository>} all matching repos of the provider
    */
   async *repositories(patterns) {
+    // @ts-ignore
     yield* this.list("repositories", patterns);
   }
 
@@ -371,6 +376,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Branch>} all matching branches of the provider
    */
   async *branches(patterns) {
+    // @ts-ignore
     yield* this.list("branches", patterns);
   }
 
@@ -380,6 +386,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Tag>} all matching tags of the provider
    */
   async *tags(patterns) {
+    // @ts-ignore
     yield* this.list("tags", patterns);
   }
 
@@ -389,6 +396,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<Hook>} all matching hooks of the provider
    */
   async *hooks(patterns) {
+    // @ts-ignore
     yield* this.list("hooks", patterns);
   }
 
@@ -398,6 +406,7 @@ export class BaseProvider extends BaseObject {
    * @return {AsyncIterable<PullRequest>} all matching pullRequests of the provider
    */
   async *pullRequests(patterns) {
+    // @ts-ignore
     yield* this.list("pullRequests", patterns);
   }
 

package/types/base-provider.d.mts

@@ -163,8 +163,9 @@ export class BaseProvider extends BaseObject {
      *
      * @param {string} type name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
      * @param {string[]|string|undefined} patterns group / repository filter
+     * @return {AsyncIterable<Repository|PullRequest|Branch|Tag|Project|Milestone|Hook>} all matching repositories of the providers
      */
-    list(type: string, patterns: string[] | string | undefined): AsyncGenerator<any, void, any>;
+    list(type: string, patterns: string[] | string | undefined): AsyncIterable<Repository | PullRequest | Branch | Tag | Project | Milestone | Hook>;
     /**
      * List projects.
      * @param {string[]|string} [patterns]
@@ -252,9 +253,9 @@ export type MessageDestination = {
 };
 import { BaseObject } from "./base-object.mjs";
 import { Repository } from "./repository.mjs";
+import { PullRequest } from "./pull-request.mjs";
 import { Branch } from "./branch.mjs";
 import { Tag } from "./tag.mjs";
 import { Hook } from "./hook.mjs";
-import { PullRequest } from "./pull-request.mjs";
 import { RepositoryGroup } from "./repository-group.mjs";
 import { ContentEntry } from "content-entry";