repository-provider - npm Package Compare versions

Comparing version 2.6.0 to 2.6.1

dist/repository-provider.js

@@ -29,2 +29,8 @@ 'use strict';
   /**
+   * called one after constructing
+   * @return {Promise}
+   */
+  async initialize() {}
+
+  /**
    * @return {Provider}
@@ -37,3 +43,3 @@ */
   /**
-   * Deliver repository nad branch name combined
+   * Deliver repository and branch name combined
    * @return {string} 'repo#branch'
@@ -128,3 +134,3 @@ */
   /**
-   * called one after constructing to
+   * called one after constructing
    * @return {Promise}
@@ -167,5 +173,5 @@ */
   /**
-   * Create a new  {@link Branch}.
+   * Create a new {@link Branch} by cloning a given source branch
    * @param {string} name
-   * @param {Promise<Branch>} source branch defaults to master
+   * @param {Branch} source branch defaults to master
    * @param {Object} options
@@ -172,0 +178,0 @@ * @return {Promise<Branch>} newly created branch

package.json

 {
   "name": "repository-provider",
-  "version": "2.6.0",
+  "version": "2.6.1",
   "main": "dist/repository-provider.js",
@@ -5,0 +5,0 @@ "module": "src/repository-provider.js",

README.md

@@ -55,2 +55,3 @@ [![npm](https://img.shields.io/npm/v/repository-provider.svg)](https://www.npmjs.com/package/repository-provider)
 -   [Branch](#branch-1)
+    -   [initialize](#initialize)
     -   [provider](#provider-1)
@@ -66,3 +67,3 @@ -   [fullName](#fullname)
 -   [Repository](#repository-1)
-    -   [initialize](#initialize)
+    -   [initialize](#initialize-1)
     -   [content](#content-2)
@@ -192,2 +193,8 @@ -   [branch](#branch-2)
 
+### initialize
+
+called one after constructing
+
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** 
+
 ### provider
@@ -199,3 +206,3 @@
 
-Deliver repository nad branch name combined
+Deliver repository and branch name combined
 
@@ -283,3 +290,3 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repo#branch'
 
-called one after constructing to
+called one after constructing
 
@@ -320,3 +327,3 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
 
-Create a new  [Branch](#branch).
+Create a new [Branch](#branch) by cloning a given source branch
 
@@ -326,3 +333,3 @@ **Parameters**
 -   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
--   `source` **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** branch defaults to master
+-   `source` **[Branch](#branch)** branch defaults to master
 -   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
@@ -329,0 +336,0 @@

src/branch.js

@@ -23,2 +23,8 @@ import { notImplementedError } from './util';
   /**
+   * called one after constructing
+   * @return {Promise}
+   */
+  async initialize() {}
+
+  /**
    * @return {Provider}
@@ -31,3 +37,3 @@ */
   /**
-   * Deliver repository nad branch name combined
+   * Deliver repository and branch name combined
    * @return {string} 'repo#branch'
@@ -34,0 +40,0 @@ */

src/repository.js

@@ -22,3 +22,3 @@ import { notImplementedError } from './util';
   /**
-   * called one after constructing to
+   * called one after constructing
    * @return {Promise}
@@ -61,5 +61,5 @@ */
   /**
-   * Create a new  {@link Branch}.
+   * Create a new {@link Branch} by cloning a given source branch
    * @param {string} name
-   * @param {Promise<Branch>} source branch defaults to master
+   * @param {Branch} source branch defaults to master
    * @param {Object} options
@@ -66,0 +66,0 @@ * @return {Promise<Branch>} newly created branch

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36397

increased by0.97%

Lines of code

747

increased by1.36%

Number of lines in readme file

447

increased by1.59%

No dependency changes