preconditions 4.0.3 → 4.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
@@ -31,7 +31,7 @@ There are four functions that are exposed from the library.
31
31
  1. errr() - Verify a one value at a time while building an 'errr' object. You can append errors together and add debug params to the stack trace.
32
32
  2. singleton() - Verify one value at a time with a chainable preconditions interface.
33
33
  3. instance() - Create a testing suite passing in a single object. Run a single, or multiple tests on the passed in object. Shouldn't be used in production code.
34
- 4. constructor() - Get the constructor function so you can extend the Preconditions library (see below for example). Shouldn't be used in production code.
34
+ 4. getConstructor() - Get the constructor function so you can extend the Preconditions library (see below for example). Shouldn't be used in production code.
35
35
 
36
36
  ### Examples Using the Errr Interface (.errr())
37
37
 
@@ -104,13 +104,13 @@ Should not be used in production code!
104
104
  </code>
105
105
  </pre>
106
106
 
107
- ### Examples Using The Constructor (.constructor())
107
+ ### Examples Using The Constructor (.getConstructor())
108
108
  Should not be used in production code!
109
109
 
110
110
  The Preconditions object itself is exposed so that you can extend the Preconditions class.
111
111
  <pre>
112
112
  <code>
113
- let Constructor = preconditions.constructor();
113
+ let Constructor = preconditions.getConstructor();
114
114
  let ChildClass = class extends Constructor {
115
115
  constructor(out) {
116
116
  super(out);
@@ -1830,7 +1830,7 @@ Preconditions entry point interface.
1830
1830
  * [.errr()](#Preconditions.errr) ⇒
1831
1831
  * [.singleton()](#Preconditions.singleton) ⇒
1832
1832
  * [.instance(objectUnderTest)](#Preconditions.instance) ⇒
1833
- * [.constructor()](#Preconditions.constructor) ⇒
1833
+ * [.getConstructor()](#Preconditions.getConstructor) ⇒
1834
1834
 
1835
1835
  <a name="Preconditions.errr"></a>
1836
1836
 
@@ -1859,9 +1859,9 @@ Validate values of a given JSON object with the preconditions object.
1859
1859
  | --- | --- |
1860
1860
  | objectUnderTest | Object Under Test |
1861
1861
 
1862
- <a name="Preconditions.constructor"></a>
1862
+ <a name="Preconditions.getConstructor"></a>
1863
1863
 
1864
- ### Preconditions.constructor() ⇒
1864
+ ### Preconditions.getConstructor() ⇒
1865
1865
  Gives ability to extend and add other preconditions to the Error Validation constructor.
1866
1866
 
1867
1867
  **Kind**: static method of <code>[Preconditions](#Preconditions)</code>