repository-provider 26.4.1 → 26.4.2

package/README.md

@@ -166,7 +166,6 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-35)
     *   [removeEntries](#removeentries)
         *   [Parameters](#parameters-36)
-    *   [entryClass](#entryclass-2)
     *   [createPullRequest](#createpullrequest)
         *   [Parameters](#parameters-37)
     *   [createBranch](#createbranch)
@@ -484,8 +483,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### Parameters
 
-*   `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)** 
+*   `options` **any** 
+*   `additionalProperties` **any** 
 
 ### update
 
@@ -1014,12 +1013,6 @@ Remove entries form the branch.
 
 *   `entries` **AsyncIterator<[ContentEntry](#contententry)>** 
 
-### entryClass
-
-By default we use the providers implementation.
-
-Returns **Class** as defined in the repository
-
 ### createPullRequest
 
 Create a pull request.
@@ -1187,7 +1180,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### displayName
 
-Beatified name use for human displaying only.
+Beautified name use for human displaying only.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
 
@@ -2043,7 +2036,7 @@ Loops over names and executes stripBaseName.
 *   `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
 *   `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
 
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** names without base
+Returns **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** names without base
 
 ## generateBranchName
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "26.4.1",
+  "version": "26.4.2",
   "publishConfig": {
     "access": "public"
   },
@@ -30,7 +30,7 @@
     "lint:tsc": "tsc --allowJs --checkJs --noEmit -module nodenext -t es2022 ./src/*.mjs"
   },
   "dependencies": {
-    "matching-iterator": "^2.0.0"
+    "matching-iterator": "^2.0.1"
   },
   "devDependencies": {
     "ava": "^4.0.1",
@@ -38,7 +38,7 @@
     "documentation": "^13.2.5",
     "repository-provider-test-support": "^1.9.9",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.6.0-dev.20220125"
+    "typescript": "^4.6.0-dev.20220126"
   },
   "engines": {
     "node": ">=14.18.3"

package/src/base-object.mjs

@@ -63,6 +63,11 @@ export class BaseObject {
     return {};
   }
 
+  /**
+   * Creates an instance of BaseObject.
+   * @param {*} options
+   * @param {*} additionalProperties
+   */
   constructor(options, additionalProperties) {
     definePropertiesFromOptions(
       this,
@@ -161,7 +166,7 @@ export class BaseObject {
    * By default we use the owners implementation.
    * @return {Class} as defined in the owner
    */
-  get hookClass() {
+   get hookClass() {
     return this.owner.hookClass;
   }
 }

package/src/branch.mjs

@@ -49,7 +49,7 @@ export class Branch extends Ref {
 
   /**
    * Are we the default branch.
-   * @return {boolean} true if name is the repository default branch
+   * @return {boolean} true if name matches the repository default branch
    */
   get isDefault() {
     return this.name === this.repository.defaultBranchName;

package/src/multi-group-provider.mjs

@@ -2,6 +2,7 @@ import { matcher } from "matching-iterator";
 import { BaseProvider } from "./base-provider.mjs";
 import { stripBaseNames } from "./util.mjs";
 import { Repository } from "./repository.mjs";
+import { Branch } from "./branch.mjs";
 import { RepositoryGroup } from "./repository-group.mjs";
 
 /**
@@ -34,6 +35,11 @@ export class MultiGroupProvider extends BaseProvider {
     }
   }
 
+  /**
+   * Lookup a branch.
+   * @param {string} name of the branch
+   * @return {Promise<Branch>}
+   */
   async branch(name) {
     const { base, group, repository, branch } = this.parseName(name);
 
@@ -78,7 +84,7 @@ export class MultiGroupProvider extends BaseProvider {
 
     yield* matcher(
       this._repositoryGroups.values(),
-      stripBaseNames(patterns,this.provider.repositoryBases),
+      stripBaseNames(patterns, this.provider.repositoryBases),
       {
         caseSensitive: this.areGroupNamesCaseSensitive,
         name: "name"

package/src/named-object.mjs

@@ -27,7 +27,7 @@ export class NamedObject extends BaseObject {
   }
 
   /**
-   * Beatified name use for human displaying only.
+   * Beautified name use for human displaying only.
    * @return {string} human readable name
    */
   get displayName() {

package/src/ref.mjs

@@ -1,11 +1,9 @@
 import { NamedObject } from "./named-object.mjs";
-
 /**
  * @typedef {Object} ContentEntry
  * @property {string} name
  * 
  */
-
 /**
  * Base for Branch and Tag
  */

package/src/util.mjs

@@ -42,7 +42,7 @@ export function stripBaseName(name, repositoryBases, whenFound) {
  * @param {*} repositoryBases
  * @param {string[]} repositoryBases all possible bases
  * @param {Function} [whenFound] to be called with the found base name
- * @return {string[]} names without base
+ * @return {string[]|undefined} names without base
  */
 export function stripBaseNames(names, repositoryBases, whenFound) {
   return names === undefined