repository-provider 32.7.7 → 32.7.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1936,7 +1936,7 @@ Lookup a repository in the provider and all of its repository groups.
1936
1936
 
1937
1937
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1938
1938
 
1939
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**&#x20;
1939
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Repository](#repository) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>**&#x20;
1940
1940
 
1941
1941
  ### repositoryGroup
1942
1942
 
@@ -1946,7 +1946,7 @@ Get a single group.
1946
1946
 
1947
1947
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1948
1948
 
1949
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** deliver the one and only present group
1949
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([RepositoryGroup](#repositorygroup) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** deliver the one and only present group
1950
1950
 
1951
1951
  ### repositoryGroups
1952
1952
 
@@ -2002,7 +2002,7 @@ Loops over names and executes stripBaseName.
2002
2002
  * `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
2003
2003
  * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
2004
2004
 
2005
- 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
2005
+ 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)> | [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
2006
2006
 
2007
2007
  ## generateBranchName
2008
2008
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "32.7.7",
3
+ "version": "32.7.8",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -7,7 +7,8 @@ export const default_attribute = {
7
7
  mandatory: false,
8
8
  private: false,
9
9
  isKey: false,
10
- additionalAttributes: []
10
+ additionalAttributes: [],
11
+ env: []
11
12
  };
12
13
 
13
14
  export const boolean_attribute = {
@@ -46,7 +46,7 @@ export class BaseProvider extends BaseObject {
46
46
  * Object with the detected key value pairs is delivered.
47
47
  * @param {Object} env as from process.env
48
48
  * @param {string} instanceIdentifier part of variable name.
49
- * @return {Object} undefined if no suitable environment variables have been found
49
+ * @return {Object|undefined} undefined if no suitable environment variables have been found
50
50
  */
51
51
  static optionsFromEnvironment(
52
52
  env,
@@ -137,7 +137,7 @@ export class BaseProvider extends BaseObject {
137
137
  * @param {Object} options additional options
138
138
  * @param {string} [options.instanceIdentifier] name of the provider instance
139
139
  * @param {Object} env taken from process.env
140
- * @return {BaseProvider} newly created provider or undefined if options are not sufficient to construct a provider
140
+ * @return {BaseProvider|undefined} newly created provider or undefined if options are not sufficient to construct a provider
141
141
  */
142
142
  static initialize(options = {}, env) {
143
143
  options = {
package/src/branch.mjs CHANGED
@@ -201,7 +201,7 @@ export class Branch extends Ref {
201
201
  * Create a new {@link Branch} by cloning a given source branch.
202
202
  * Simply calls Repository.createBranch() with the receiver as source branch
203
203
  * @param {string} name the new branch
204
- * @param {Object} options
204
+ * @param {Object|undefined} options
205
205
  * @return {Promise<Branch>} newly created branch (or already present old one with the same name)
206
206
  */
207
207
  async createBranch(name, options) {
@@ -16,7 +16,7 @@ export class MultiGroupProvider extends BaseProvider {
16
16
  /**
17
17
  * Lookup a repository in the provider and all of its repository groups.
18
18
  * @param {string} name of the repository
19
- * @return {Promise<Repository>}
19
+ * @return {Promise<Repository|undefined>}
20
20
  */
21
21
  async repository(name) {
22
22
  const { base, group, repository } = this.parseName(name);
@@ -35,7 +35,7 @@ export class MultiGroupProvider extends BaseProvider {
35
35
  /**
36
36
  * Lookup a branch.
37
37
  * @param {string} name of the branch
38
- * @return {Promise<Branch>}
38
+ * @return {Promise<Branch|undefined>}
39
39
  */
40
40
  async branch(name) {
41
41
  const { base, group, repository, branch } = this.parseName(name);
@@ -57,7 +57,7 @@ export class MultiGroupProvider extends BaseProvider {
57
57
  /**
58
58
  * Lookup a repository group.
59
59
  * @param {string} name of the group
60
- * @return {Promise<RepositoryGroup>}
60
+ * @return {Promise<RepositoryGroup|undefined>}
61
61
  */
62
62
  async repositoryGroup(name) {
63
63
  const { base } = this.parseName(name);
@@ -251,7 +251,7 @@ export class Repository extends OwnedObject {
251
251
  * Add a new {@link Branch}.
252
252
  * Internal branch creation does not call repository.initialize()
253
253
  * @param {string} name of the new branch
254
- * @param {Object} options to be passed to the branch
254
+ * @param {Object|undefined} options to be passed to the branch
255
255
  * @return {Branch} newly created branch
256
256
  */
257
257
  addBranch(name, options) {
@@ -306,7 +306,7 @@ export class Repository extends OwnedObject {
306
306
  * Add a new {@link Tag}.
307
307
  * Internal tag creation does not call repository.initialize()
308
308
  * @param {string} name of the new tag
309
- * @param {Object} options
309
+ * @param {Object|undefined} options
310
310
  * @return {Tag} newly created tag
311
311
  */
312
312
  addTag(name, options) {
@@ -321,7 +321,7 @@ export class Repository extends OwnedObject {
321
321
  * Create a pull request (or deliver an already present for the given name).
322
322
  * @param {string} name of the pr
323
323
  * @param {Branch} source branch
324
- * @param {Object} options
324
+ * @param {Object|undefined} options
325
325
  * @return {Promise<PullRequest>}
326
326
  */
327
327
  async createPullRequest(name, source, options) {
@@ -419,7 +419,7 @@ export class Repository extends OwnedObject {
419
419
  /**
420
420
  * Get a Hook.
421
421
  * @param {string|number} id
422
- * @return {Promise<Hook>} for the given id
422
+ * @return {Promise<Hook|undefined>} for the given id
423
423
  */
424
424
  async hook(id) {
425
425
  for await (const hook of this.hooks()) {