repository-provider 27.0.1 → 27.0.4

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
@@ -374,8 +374,11 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
374
374
  * `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
375
375
  * `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
376
376
  * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
377
+ * `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
377
378
  * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
378
379
  * `default` **any?** the default value
380
+ * `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
381
+ * `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
379
382
  * `env` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)?** environment variable use to provide the value
380
383
 
381
384
  ## definePropertiesFromOptions
@@ -537,37 +540,37 @@ Forwarded to the owner.
537
540
 
538
541
  By default we use the owners implementation.
539
542
 
540
- Returns **Class** as defined in the owner
543
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
541
544
 
542
545
  ### pullRequestClass
543
546
 
544
547
  By default we use the owners implementation.
545
548
 
546
- Returns **Class** as defined in the owner
549
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
547
550
 
548
551
  ### branchClass
549
552
 
550
553
  By default we use the owners implementation.
551
554
 
552
- Returns **Class** as defined in the owner
555
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
553
556
 
554
557
  ### tagClass
555
558
 
556
559
  By default we use the owners implementation.
557
560
 
558
- Returns **Class** as defined in the owner
561
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
559
562
 
560
563
  ### entryClass
561
564
 
562
565
  By default we use the owners implementation.
563
566
 
564
- Returns **Class** as defined in the owner
567
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
565
568
 
566
569
  ### hookClass
567
570
 
568
571
  By default we use the owners implementation.
569
572
 
570
- Returns **Class** as defined in the owner
573
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** as defined in the owner
571
574
 
572
575
  ### attributes
573
576
 
@@ -829,31 +832,31 @@ return {object}
829
832
 
830
833
  ### repositoryGroupClass
831
834
 
832
- Returns **Class** repository group class used by the Provider
835
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** repository group class used by the Provider
833
836
 
834
837
  ### hookClass
835
838
 
836
- Returns **Class** hook class used by the Provider
839
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** hook class used by the Provider
837
840
 
838
841
  ### repositoryClass
839
842
 
840
- Returns **Class** repository class used by the Provider
843
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** repository class used by the Provider
841
844
 
842
845
  ### branchClass
843
846
 
844
- Returns **Class** branch class used by the Provider
847
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** branch class used by the Provider
845
848
 
846
849
  ### tagClass
847
850
 
848
- Returns **Class** branch class used by the Provider
851
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** branch class used by the Provider
849
852
 
850
853
  ### entryClass
851
854
 
852
- Returns **Class** entry class used by the Provider
855
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** entry class used by the Provider
853
856
 
854
857
  ### pullRequestClass
855
858
 
856
- Returns **Class** pull request class used by the Provider
859
+ Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** pull request class used by the Provider
857
860
 
858
861
  ### instanceIdentifier
859
862
 
@@ -1181,7 +1184,7 @@ Check for equality.
1181
1184
 
1182
1185
  * `other` **[NamedObject](#namedobject)**
1183
1186
 
1184
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if names are equal
1187
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if names are equal and have the same owner
1185
1188
 
1186
1189
  ### displayName
1187
1190
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "27.0.1",
3
+ "version": "27.0.4",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -27,18 +27,18 @@
27
27
  "docs": "documentation readme --section=API ./src/**/*.mjs",
28
28
  "lint": "npm run lint:docs && npm run lint:tsc",
29
29
  "lint:docs": "documentation lint ./src/**/*.mjs",
30
- "lint:tsc": "tsc --allowJs --checkJs --noEmit -module nodenext -t es2022 ./src/*.mjs"
30
+ "lint:tsc": "tsc --allowJs --checkJs --noEmit -t es2022 ./src/*.mjs"
31
31
  },
32
32
  "dependencies": {
33
- "matching-iterator": "^2.0.2"
33
+ "matching-iterator": "^2.0.3"
34
34
  },
35
35
  "devDependencies": {
36
- "ava": "^4.0.1",
36
+ "ava": "^4.1.0",
37
37
  "c8": "^7.11.0",
38
38
  "documentation": "^13.2.5",
39
- "repository-provider-test-support": "^1.12.7",
39
+ "repository-provider-test-support": "^1.12.9",
40
40
  "semantic-release": "^19.0.2",
41
- "typescript": "^4.6.0-dev.20220210"
41
+ "typescript": "^4.6.2"
42
42
  },
43
43
  "engines": {
44
44
  "node": ">=14.18.3"
@@ -124,7 +124,7 @@ export class BaseObject {
124
124
 
125
125
  /**
126
126
  * By default we use the owners implementation.
127
- * @return {Class} as defined in the owner
127
+ * @return {Function} as defined in the owner
128
128
  */
129
129
  get repositoryClass() {
130
130
  return this.owner.repositoryClass;
@@ -132,7 +132,7 @@ export class BaseObject {
132
132
 
133
133
  /**
134
134
  * By default we use the owners implementation.
135
- * @return {Class} as defined in the owner
135
+ * @return {Function} as defined in the owner
136
136
  */
137
137
  get pullRequestClass() {
138
138
  return this.owner.pullRequestClass;
@@ -140,7 +140,7 @@ export class BaseObject {
140
140
 
141
141
  /**
142
142
  * By default we use the owners implementation.
143
- * @return {Class} as defined in the owner
143
+ * @return {Function} as defined in the owner
144
144
  */
145
145
  get branchClass() {
146
146
  return this.owner.branchClass;
@@ -148,7 +148,7 @@ export class BaseObject {
148
148
 
149
149
  /**
150
150
  * By default we use the owners implementation.
151
- * @return {Class} as defined in the owner
151
+ * @return {Function} as defined in the owner
152
152
  */
153
153
  get tagClass() {
154
154
  return this.owner.tagClass;
@@ -156,7 +156,7 @@ export class BaseObject {
156
156
 
157
157
  /**
158
158
  * By default we use the owners implementation.
159
- * @return {Class} as defined in the owner
159
+ * @return {Function} as defined in the owner
160
160
  */
161
161
  get entryClass() {
162
162
  return this.owner.entryClass;
@@ -164,7 +164,7 @@ export class BaseObject {
164
164
 
165
165
  /**
166
166
  * By default we use the owners implementation.
167
- * @return {Class} as defined in the owner
167
+ * @return {Function} as defined in the owner
168
168
  */
169
169
  get hookClass() {
170
170
  return this.owner.hookClass;
@@ -462,49 +462,49 @@ export class BaseProvider extends BaseObject {
462
462
  }
463
463
 
464
464
  /**
465
- * @return {Class} repository group class used by the Provider
465
+ * @return {Function} repository group class used by the Provider
466
466
  */
467
467
  get repositoryGroupClass() {
468
468
  return RepositoryGroup;
469
469
  }
470
470
 
471
471
  /**
472
- * @return {Class} hook class used by the Provider
472
+ * @return {Function} hook class used by the Provider
473
473
  */
474
474
  get hookClass() {
475
475
  return Hook;
476
476
  }
477
477
 
478
478
  /**
479
- * @return {Class} repository class used by the Provider
479
+ * @return {Function} repository class used by the Provider
480
480
  */
481
481
  get repositoryClass() {
482
482
  return Repository;
483
483
  }
484
484
 
485
485
  /**
486
- * @return {Class} branch class used by the Provider
486
+ * @return {Function} branch class used by the Provider
487
487
  */
488
488
  get branchClass() {
489
489
  return Branch;
490
490
  }
491
491
 
492
492
  /**
493
- * @return {Class} branch class used by the Provider
493
+ * @return {Function} branch class used by the Provider
494
494
  */
495
495
  get tagClass() {
496
496
  return Tag;
497
497
  }
498
498
 
499
499
  /**
500
- * @return {Class} entry class used by the Provider
500
+ * @return {Function} entry class used by the Provider
501
501
  */
502
502
  get entryClass() {
503
503
  return undefined;
504
504
  }
505
505
 
506
506
  /**
507
- * @return {Class} pull request class used by the Provider
507
+ * @return {Function} pull request class used by the Provider
508
508
  */
509
509
  get pullRequestClass() {
510
510
  return PullRequest;
@@ -20,7 +20,7 @@ export class NamedObject extends BaseObject {
20
20
  /**
21
21
  * Check for equality.
22
22
  * @param {NamedObject} other
23
- * @return {boolean} true if names are equal
23
+ * @return {boolean} true if names are equal and have the same owner
24
24
  */
25
25
  equals(other) {
26
26
  return super.equals(other) && this.name === other.name;