repository-provider 27.0.6 → 28.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "27.0.6",
+  "version": "28.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -41,7 +41,7 @@
     "typescript": "^4.6.3"
   },
   "engines": {
-    "node": ">=14.18.3"
+    "node": ">=16.14.2"
   },
   "repository": {
     "type": "git",

package/src/base-provider.mjs

@@ -12,9 +12,9 @@ import { BaseObject } from "./base-object.mjs";
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
- * @param {Function} info
- * @param {Function} warn
- * @param {Function} error
+ * @property {Function} info
+ * @property {Function} warn
+ * @property {Function} error
  */
 
 /**
@@ -31,8 +31,8 @@ export class BaseProvider extends BaseObject {
   /**
    * Extract options suitable for the constructor
    * form the given set of environment variables.
-   * @param {Object} env taken from process.env
-   * @param {string} instanceIdentifier
+   * @param {Object} env as of from process.env
+   * @param {string} instanceIdentifier part of variable name.
    * @return {Object} undefined if no suitable environment variables have been found
    */
   static optionsFromEnvironment(
@@ -89,7 +89,7 @@ export class BaseProvider extends BaseObject {
     return {
       ...super.attributes,
       /**
-       * In case there are several provider able to support a given source which one sould be used ?
+       * In case there are several providers able to support a given source which one sould be used ?
        * this defines the order
        */
       priority: {
@@ -98,7 +98,7 @@ export class BaseProvider extends BaseObject {
       },
 
       /**
-       * Name of the provider
+       * Name of the provider.
        */
       name: {
         type: "string",
@@ -111,7 +111,7 @@ export class BaseProvider extends BaseObject {
       },
 
       /**
-       * to forward info/warn and error messages to
+       * To forward info/warn and error messages to
        */
       messageDestination: {
         type: "object",

package/src/branch.mjs

@@ -32,7 +32,7 @@ export class Branch extends Ref {
   }
 
   /**
-   * @return {string} tags
+   * @return {string} heades
    */
   get refType() {
     return "heads";

package/src/commit.mjs

@@ -5,10 +5,17 @@
  * @property {string} ref
  */
 
+export class User
+{
+
+}
+
 /**
  * @property {Repository} repository
  * @property {string} message
  * @property {string} sha
+ * @property {User} author
+ * @property {User} committer
  */
 export class Commit {
   constructor(repository) {

package/src/repository.mjs

@@ -149,6 +149,14 @@ export class Repository extends NamedObject {
     return (await this.defaultBranch).maybeEntry(name);
   }
 
+  /**
+   * List commits of the default branch.
+   * @param {Object} options
+   * @return {AsyncIterator<Commit>} all matching commits in the repository
+   */
+  async *commits(options) {
+  }
+
   /**
    * Urls to access the repo.
    * @return {string[]}

package/src/tag.mjs

@@ -17,7 +17,7 @@ export class Tag extends Ref {
   }
 
   /**
-   * 
+   * Tags cannot be written to.
    * @return {boolean} false
    */
   get isWritable()