repository-provider - npm Package Compare versions

Comparing version 2.9.0 to 2.10.0

dist/repository-provider.js

@@ -10,3 +10,3 @@ 'use strict';
 /**
- * Abstract git branch
+ * Abstract branch
  * @see {@link Repository#addBranch}
@@ -44,3 +44,3 @@ * @param {Repository} repository
    * Branch owner
-   * By default we provide the branch owner
+   * By default we provide the repository owner
    * @see {@link Repository#owner}
@@ -54,2 +54,12 @@ * @return {string}
   /**
+   * Branch project
+   * By default we provide the repository project
+   * @see {@link Repository#project}
+   * @return {string}
+   */
+  get project() {
+    return this.repository.project;
+  }
+
+  /**
    * Deliver repository and branch name combined
@@ -145,4 +155,4 @@ * @return {string} 'repo#branch'
   /**
-   * called one after constructing
-   * @return {Promise}
+   * Called one after constructing
+   * @return {Promise<undefined>}
    */
@@ -153,2 +163,3 @@ async initialize() {}
    * Lookup content form the default branch
+   * @see {@link Branch#content}
    * @return {Content}
@@ -170,3 +181,4 @@ */
    * Repository owner
-   * @return {string}
+   * Default implementation delivers undefined
+   * @return {string} undefined
    */
@@ -178,2 +190,11 @@ get owner() {
   /**
+   * Repository project
+   * Default implementation delivers undefined
+   * @return {string} undefined
+   */
+  get project() {
+    return undefined;
+  }
+
+  /**
    * Lookup branch by name
@@ -228,3 +249,3 @@ * @param {string} name
    * @param {Branch} branch
-   * @return {Promise}
+   * @return {Promise<undefined>}
    */
@@ -231,0 +252,0 @@ async addBranch(branch) {

package.json

 {
   "name": "repository-provider",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "main": "dist/repository-provider.js",
@@ -40,3 +40,3 @@ "module": "src/repository-provider.js",
     "documentation": "^5.3.5",
-    "travis-deploy-once": "^4.3.1"
+    "travis-deploy-once": "^4.3.2"
   },
@@ -43,0 +43,0 @@ "engines": {

README.md

@@ -59,2 +59,3 @@ [![npm](https://img.shields.io/npm/v/repository-provider.svg)](https://www.npmjs.com/package/repository-provider)
     -   [owner](#owner)
+    -   [project](#project)
     -   [fullName](#fullname)
@@ -73,2 +74,3 @@ -   [delete](#delete)
     -   [owner](#owner-1)
+    -   [project](#project-1)
     -   [branch](#branch-2)
@@ -194,3 +196,3 @@ -   [defaultBranch](#defaultbranch)
 
-Abstract git branch
+Abstract branch
 
@@ -223,6 +225,15 @@ **Parameters**
 Branch owner
-By default we provide the branch owner
+By default we provide the repository owner
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+### project
+
+-   **See: [Repository#project](#repositoryproject)**
+
+Branch project
+By default we provide the repository project
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ### fullName
@@ -313,8 +324,10 @@
 
-called one after constructing
+Called one after constructing
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>** 
 
 ### content
 
+-   **See: [Branch#content](#branchcontent)**
+
 Lookup content form the default branch
@@ -337,5 +350,13 @@
 Repository owner
+Default implementation delivers undefined
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** undefined
 
+### project
+
+Repository project
+Default implementation delivers undefined
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** undefined
+
 ### branch
@@ -391,3 +412,3 @@
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>** 
 
@@ -394,0 +415,0 @@ ### pullRequests

src/branch.js

 import { notImplementedError } from './util';
 
 /**
- * Abstract git branch
+ * Abstract branch
  * @see {@link Repository#addBranch}
@@ -37,3 +37,3 @@ * @param {Repository} repository
    * Branch owner
-   * By default we provide the branch owner
+   * By default we provide the repository owner
    * @see {@link Repository#owner}
@@ -47,2 +47,12 @@ * @return {string}
   /**
+   * Branch project
+   * By default we provide the repository project
+   * @see {@link Repository#project}
+   * @return {string}
+   */
+  get project() {
+    return this.repository.project;
+  }
+
+  /**
    * Deliver repository and branch name combined
@@ -49,0 +59,0 @@ * @return {string} 'repo#branch'

src/repository.js

@@ -22,4 +22,4 @@ import { notImplementedError } from './util';
   /**
-   * called one after constructing
-   * @return {Promise}
+   * Called one after constructing
+   * @return {Promise<undefined>}
    */
@@ -30,2 +30,3 @@ async initialize() {}
    * Lookup content form the default branch
+   * @see {@link Branch#content}
    * @return {Content}
@@ -47,3 +48,4 @@ */
    * Repository owner
-   * @return {string}
+   * Default implementation delivers undefined
+   * @return {string} undefined
    */
@@ -55,2 +57,11 @@ get owner() {
   /**
+   * Repository project
+   * Default implementation delivers undefined
+   * @return {string} undefined
+   */
+  get project() {
+    return undefined;
+  }
+
+  /**
    * Lookup branch by name
@@ -105,3 +116,3 @@ * @param {string} name
    * @param {Branch} branch
-   * @return {Promise}
+   * @return {Promise<undefined>}
    */
@@ -108,0 +119,0 @@ async addBranch(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

40587

increased by4.45%

Lines of code

859

increased by4.63%

Number of lines in readme file

503

increased by4.36%

No dependency changes