@parischap/conversions 0.1.0 → 0.2.0

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.
Files changed (125) hide show
  1. package/README.md +51 -50
  2. package/cjs/BigDecimal.js +2 -2
  3. package/cjs/BigInt.js +7 -5
  4. package/cjs/BigInt.js.map +1 -1
  5. package/cjs/DateTime.js +144 -136
  6. package/cjs/DateTime.js.map +1 -1
  7. package/cjs/DateTimeFormat.js +7 -2
  8. package/cjs/DateTimeFormat.js.map +1 -1
  9. package/cjs/DateTimeFormatContext.js +11 -6
  10. package/cjs/DateTimeFormatContext.js.map +1 -1
  11. package/cjs/Email.js +11 -15
  12. package/cjs/Email.js.map +1 -1
  13. package/cjs/Integer.js +33 -23
  14. package/cjs/Integer.js.map +1 -1
  15. package/cjs/NumberBase10Format.js +65 -65
  16. package/cjs/PositiveInteger.js +44 -29
  17. package/cjs/PositiveInteger.js.map +1 -1
  18. package/cjs/PositiveReal.js +34 -24
  19. package/cjs/PositiveReal.js.map +1 -1
  20. package/cjs/Real.js +29 -18
  21. package/cjs/Real.js.map +1 -1
  22. package/cjs/RoundingMode.js +7 -4
  23. package/cjs/RoundingMode.js.map +1 -1
  24. package/cjs/RoundingOption.js +6 -6
  25. package/cjs/RoundingOption.js.map +1 -1
  26. package/cjs/Schema.js +29 -28
  27. package/cjs/Schema.js.map +1 -1
  28. package/cjs/SemVer.js +19 -20
  29. package/cjs/SemVer.js.map +1 -1
  30. package/cjs/Template.js +36 -31
  31. package/cjs/Template.js.map +1 -1
  32. package/cjs/TemplatePart.js +4 -4
  33. package/cjs/TemplateParts.js +3 -2
  34. package/cjs/TemplateParts.js.map +1 -1
  35. package/cjs/TemplatePlaceholder.js +56 -45
  36. package/cjs/TemplatePlaceholder.js.map +1 -1
  37. package/cjs/TemplateSeparator.js +17 -24
  38. package/cjs/TemplateSeparator.js.map +1 -1
  39. package/cjs/internal/Int.js +5 -8
  40. package/cjs/internal/Int.js.map +1 -1
  41. package/cjs/internal/Positive.js +5 -8
  42. package/cjs/internal/Positive.js.map +1 -1
  43. package/dts/BigDecimal.d.ts +2 -2
  44. package/dts/BigDecimal.d.ts.map +1 -1
  45. package/dts/BigInt.d.ts +7 -5
  46. package/dts/BigInt.d.ts.map +1 -1
  47. package/dts/DateTime.d.ts +145 -137
  48. package/dts/DateTime.d.ts.map +1 -1
  49. package/dts/DateTimeFormat.d.ts +7 -2
  50. package/dts/DateTimeFormat.d.ts.map +1 -1
  51. package/dts/DateTimeFormatContext.d.ts +17 -12
  52. package/dts/DateTimeFormatContext.d.ts.map +1 -1
  53. package/dts/Email.d.ts +16 -13
  54. package/dts/Email.d.ts.map +1 -1
  55. package/dts/Integer.d.ts +43 -21
  56. package/dts/Integer.d.ts.map +1 -1
  57. package/dts/NumberBase10Format.d.ts +68 -68
  58. package/dts/PositiveInteger.d.ts +54 -27
  59. package/dts/PositiveInteger.d.ts.map +1 -1
  60. package/dts/PositiveReal.d.ts +44 -22
  61. package/dts/PositiveReal.d.ts.map +1 -1
  62. package/dts/Real.d.ts +39 -16
  63. package/dts/Real.d.ts.map +1 -1
  64. package/dts/RoundingMode.d.ts +6 -3
  65. package/dts/RoundingMode.d.ts.map +1 -1
  66. package/dts/RoundingOption.d.ts +6 -6
  67. package/dts/Schema.d.ts +32 -33
  68. package/dts/Schema.d.ts.map +1 -1
  69. package/dts/SemVer.d.ts +25 -13
  70. package/dts/SemVer.d.ts.map +1 -1
  71. package/dts/Template.d.ts +30 -29
  72. package/dts/Template.d.ts.map +1 -1
  73. package/dts/TemplatePart.d.ts +4 -4
  74. package/dts/TemplateParts.d.ts +4 -3
  75. package/dts/TemplateParts.d.ts.map +1 -1
  76. package/dts/TemplatePlaceholder.d.ts +56 -44
  77. package/dts/TemplatePlaceholder.d.ts.map +1 -1
  78. package/dts/TemplateSeparator.d.ts +9 -51
  79. package/dts/TemplateSeparator.d.ts.map +1 -1
  80. package/dts/internal/Int.d.ts +0 -4
  81. package/dts/internal/Int.d.ts.map +1 -1
  82. package/dts/internal/Positive.d.ts +0 -4
  83. package/dts/internal/Positive.d.ts.map +1 -1
  84. package/esm/BigDecimal.js +2 -2
  85. package/esm/BigInt.js +7 -5
  86. package/esm/BigInt.js.map +1 -1
  87. package/esm/DateTime.js +144 -136
  88. package/esm/DateTime.js.map +1 -1
  89. package/esm/DateTimeFormat.js +7 -2
  90. package/esm/DateTimeFormat.js.map +1 -1
  91. package/esm/DateTimeFormatContext.js +11 -6
  92. package/esm/DateTimeFormatContext.js.map +1 -1
  93. package/esm/Email.js +10 -13
  94. package/esm/Email.js.map +1 -1
  95. package/esm/Integer.js +33 -23
  96. package/esm/Integer.js.map +1 -1
  97. package/esm/NumberBase10Format.js +65 -65
  98. package/esm/PositiveInteger.js +44 -29
  99. package/esm/PositiveInteger.js.map +1 -1
  100. package/esm/PositiveReal.js +34 -24
  101. package/esm/PositiveReal.js.map +1 -1
  102. package/esm/Real.js +29 -18
  103. package/esm/Real.js.map +1 -1
  104. package/esm/RoundingMode.js +6 -3
  105. package/esm/RoundingMode.js.map +1 -1
  106. package/esm/RoundingOption.js +6 -6
  107. package/esm/RoundingOption.js.map +1 -1
  108. package/esm/Schema.js +33 -34
  109. package/esm/Schema.js.map +1 -1
  110. package/esm/SemVer.js +18 -18
  111. package/esm/SemVer.js.map +1 -1
  112. package/esm/Template.js +36 -31
  113. package/esm/Template.js.map +1 -1
  114. package/esm/TemplatePart.js +4 -4
  115. package/esm/TemplateParts.js +3 -2
  116. package/esm/TemplateParts.js.map +1 -1
  117. package/esm/TemplatePlaceholder.js +55 -44
  118. package/esm/TemplatePlaceholder.js.map +1 -1
  119. package/esm/TemplateSeparator.js +16 -24
  120. package/esm/TemplateSeparator.js.map +1 -1
  121. package/esm/internal/Int.js +5 -7
  122. package/esm/internal/Int.js.map +1 -1
  123. package/esm/internal/Positive.js +5 -7
  124. package/esm/internal/Positive.js.map +1 -1
  125. package/package.json +2 -2
package/cjs/Email.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Email.js","names":["_effectLib","require","_effect","moduleTag","exports","TypeId","Symbol","for","unsafeFromString","Brand","nominal","constructor","refined","MString","isEmail","s","error","fromStringOption","option","bind","fromString","either","fromStringOrThrow","has","input","SchemaFromString","Schema","String","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Email.ts"],"sourcesContent":[null],"mappings":";;;;;;AAEA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AAHA;;AAKA;;;;;AAKO,MAAME,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,+BAA+B;AAExD;;;;;AAKO,MAAME,MAAM,GAAAD,OAAA,CAAAC,MAAA,gBAAkBC,MAAM,CAACC,GAAG,CAACJ,SAAS,CAAY;AAUrE;;;;;AAKO,MAAMK,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,gBAAGN,OAAA,CAAAO,KAAK,CAACC,OAAO,EAAQ;AAErD;;;;;;AAMO,MAAMC,WAAW,GAAAP,OAAA,CAAAO,WAAA,gBAAGT,OAAA,CAAAO,KAAK,CAACG,OAAO,CAAOZ,UAAA,CAAAa,OAAO,CAACC,OAAO,EAAGC,CAAC,IACjEb,OAAA,CAAAO,KAAK,CAACO,KAAK,CAAC,IAAID,CAAC,8BAA8B,CAAC,CAChD;AAED;;;;;AAKO,MAAME,gBAAgB,GAAAb,OAAA,CAAAa,gBAAA,gBAGzBN,WAAW,CAACO,MAAM,CAACC,IAAI,CAACR,WAAW,CAAC;AAExC;;;;;AAKO,MAAMS,UAAU,GAAAhB,OAAA,CAAAgB,UAAA,gBAGnBT,WAAW,CAACU,MAAM,CAACF,IAAI,CAACR,WAAW,CAAC;AAExC;;;;;AAKO,MAAMW,iBAAiB,GAAAlB,OAAA,CAAAkB,iBAAA,GAAwCX,WAAW;AAEjF;;;;;AAKO,MAAMY,GAAG,GAAIC,KAAa,IAAoBxB,UAAA,CAAAa,OAAO,CAACC,OAAO,CAACU,KAAK,CAAC;AAE3E;;;;;AAAApB,OAAA,CAAAmB,GAAA,GAAAA,GAAA;AAKO,MAAME,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,gBAAgCvB,OAAA,CAAAwB,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9E1B,OAAA,CAAAwB,MAAM,CAACG,SAAS,CAAClB,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMmB,cAAc,GAAA1B,OAAA,CAAA0B,cAAA,gBAAwB5B,OAAA,CAAAwB,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
1
+ {"version":3,"file":"Email.js","names":["_effectLib","require","_effect","moduleTag","exports","TypeId","Symbol","for","unsafeFromString","Brand","nominal","constructor","refined","MString","isEmail","s","error","fromStringOption","option","bind","fromString","either","fromStringOrThrow","SchemaFromString","Schema","String","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Email.ts"],"sourcesContent":[null],"mappings":";;;;;;AAMA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AAPA;;;;;;AASA;;;;;AAKO,MAAME,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,+BAA+B;AAExD;;;;;AAKO,MAAME,MAAM,GAAAD,OAAA,CAAAC,MAAA,gBAAkBC,MAAM,CAACC,GAAG,CAACJ,SAAS,CAAY;AAUrE;;;;;AAKO,MAAMK,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,gBAAGN,OAAA,CAAAO,KAAK,CAACC,OAAO,EAAQ;AAErD;;;;;AAKO,MAAMC,WAAW,GAAAP,OAAA,CAAAO,WAAA,gBAAGT,OAAA,CAAAO,KAAK,CAACG,OAAO,CAAOZ,UAAA,CAAAa,OAAO,CAACC,OAAO,EAAGC,CAAC,IACjEb,OAAA,CAAAO,KAAK,CAACO,KAAK,CAAC,IAAID,CAAC,8BAA8B,CAAC,CAChD;AAED;;;;;AAKO,MAAME,gBAAgB,GAAAb,OAAA,CAAAa,gBAAA,gBAGzBN,WAAW,CAACO,MAAM,CAACC,IAAI,CAACR,WAAW,CAAC;AAExC;;;;;AAKO,MAAMS,UAAU,GAAAhB,OAAA,CAAAgB,UAAA,gBAGnBT,WAAW,CAACU,MAAM,CAACF,IAAI,CAACR,WAAW,CAAC;AAExC;;;;;AAKO,MAAMW,iBAAiB,GAAAlB,OAAA,CAAAkB,iBAAA,GAAwCX,WAAW;AAEjF;;;;;AAKO,MAAMY,gBAAgB,GAAAnB,OAAA,CAAAmB,gBAAA,gBAAgCrB,OAAA,CAAAsB,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9ExB,OAAA,CAAAsB,MAAM,CAACG,SAAS,CAAChB,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMiB,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,gBAAwB1B,OAAA,CAAAsB,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
package/cjs/Integer.js CHANGED
@@ -28,8 +28,10 @@ function _interopRequireWildcard(e, t) {
28
28
  })(e, t);
29
29
  }
30
30
  /**
31
- * This module implements a finite integer brand (Infinity, NaN or non-null fractional part
32
- * disallowed)
31
+ * This module implements a CVInteger brand, i.e. a number that represents an integer (Infinity, NaN
32
+ * disallowed). Can be used to represent a floor in a lift, a signed quantity... See the `Effect`
33
+ * documentation about Branding (https://effect.website/docs/code-style/branded-types/) if you are
34
+ * not familiar with this concept.
33
35
  */
34
36
 
35
37
  /**
@@ -41,115 +43,123 @@ const moduleTag = exports.moduleTag = '@parischap/conversions/Integer/';
41
43
  /**
42
44
  * Brand constructor. Should not be used directly
43
45
  *
44
- * @category Constructors
46
+ * @ignore
45
47
  */
46
48
  const constructor = exports.constructor = /*#__PURE__*/_effect.Brand.all(CVReal.constructor, CVInt.constructor);
47
49
  /**
48
- * Constructs an Integer from a number without any verifications
50
+ * Constructs a `CVInteger` from a number without any verifications
49
51
  *
50
52
  * @category Constructors
51
53
  */
52
54
  const unsafeFromNumber = exports.unsafeFromNumber = /*#__PURE__*/_effect.Brand.nominal();
53
55
  /**
54
- * Constructs an Option of an Integer from a number
56
+ * Tries to construct a `CVInteger` from a number. Returns a `Some` if the conversion can be
57
+ * performed, a `None` otherwise
55
58
  *
56
59
  * @category Constructors
57
60
  */
58
61
  const fromNumberOption = exports.fromNumberOption = /*#__PURE__*/constructor.option.bind(constructor);
59
62
  /**
60
- * Constructs an Either of an Integer from a number
63
+ * Tries to construct a `CVnteger` from a number. Returns a `Right` if the conversion can be
64
+ * performed, a `Left` otherwise
61
65
  *
62
66
  * @category Constructors
63
67
  */
64
68
  const fromNumber = exports.fromNumber = /*#__PURE__*/constructor.either.bind(constructor);
65
69
  /**
66
- * Constructs an Integer from a number or throws
70
+ * Constructs a `CVInteger` from a number if possible. Throws otherwise
67
71
  *
68
72
  * @category Constructors
69
73
  */
70
74
  const fromNumberOrThrow = exports.fromNumberOrThrow = constructor;
71
75
  /**
72
- * Constructs an Integer from a BigDecimal without any checks
76
+ * Constructs a `CVInteger` from a `BigDecimal` without any checks
73
77
  *
74
78
  * @category Constructors
75
79
  */
76
80
  const unsafeFromBigDecimal = exports.unsafeFromBigDecimal = CVReal.unsafeFromBigDecimal;
77
81
  /**
78
- * Constructs an Option of an Integer from a BigDecimal
82
+ * Tries to construct a `CVInteger` from a `BigDecimal`. Returns a `Some` if the conversion can be
83
+ * performed, a `None` otherwise
79
84
  *
80
85
  * @category Constructors
81
86
  */
82
87
  const fromBigDecimalOption = exports.fromBigDecimalOption = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigDecimalOption, /*#__PURE__*/_effect.Option.flatMap(CVInt.fromNumberOption));
83
88
  /**
84
- * Constructs an Either of an Integer from a BigDecimal
89
+ * Tries to construct a `CVInteger` from a `BigDecimal`. Returns a `Right` if the conversion can be
90
+ * performed, a `Left` otherwise
85
91
  *
86
92
  * @category Constructors
87
93
  */
88
94
  const fromBigDecimal = exports.fromBigDecimal = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigDecimal, /*#__PURE__*/_effect.Either.flatMap(CVInt.fromNumber));
89
95
  /**
90
- * Constructs an Integer from a BigDecimal or throws
96
+ * Constructs a `CVInteger` from a `BigDecimal` if possible. Throws otherwise
91
97
  *
92
98
  * @category Constructors
93
99
  */
94
100
  const fromBigDecimalOrThrow = exports.fromBigDecimalOrThrow = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigDecimalOrThrow, CVInt.fromNumberOrThrow);
95
101
  /**
96
- * Constructs an Integer from a BigInt without any checks
102
+ * Constructs a `CVInteger` from a `BigInt` without any checks
97
103
  *
98
104
  * @category Constructors
99
105
  */
100
106
  const unsafeFromBigInt = exports.unsafeFromBigInt = CVReal.unsafeFromBigInt;
101
107
  /**
102
- * Constructs an Option of an Integer from a BigInt
108
+ * Tries to construct a `CVInteger` from a `BigInt`. Returns a `Some` if the conversion can be
109
+ * performed, a `None` otherwise
103
110
  *
104
111
  * @category Constructors
105
112
  */
106
113
  const fromBigIntOption = exports.fromBigIntOption = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigIntOption);
107
114
  /**
108
- * Constructs an Either of an Integer from a BigInt
115
+ * Tries to construct a `CVInteger` from a `BigInt`. Returns a `Right` if the conversion can be
116
+ * performed, a `Left` otherwise
109
117
  *
110
118
  * @category Constructors
111
119
  */
112
120
  const fromBigInt = exports.fromBigInt = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigInt, /*#__PURE__*/_effect.Either.flatMap(CVInt.fromNumber));
113
121
  /**
114
- * Constructs an Integer from a BigInt or throws
122
+ * Constructs a `CVInteger` from a `BigInt` if possible. Throws otherwise
115
123
  *
116
124
  * @category Constructors
117
125
  */
118
126
  const fromBigIntOrThrow = exports.fromBigIntOrThrow = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigIntOrThrow);
119
127
  /**
120
- * Constructs an Integer from a Real without any checks
128
+ * Constructs a `CVInteger` from a `CVReal` without any checks
121
129
  *
122
130
  * @category Constructors
123
131
  */
124
132
  const unsafeFromReal = exports.unsafeFromReal = _effect.Function.identity;
125
133
  /**
126
- * Constructs an Option of an Integer from a Real
134
+ * Tries to construct a `CVInteger` from a `CVReal`. Returns a `Some` if the conversion can be
135
+ * performed, a `None` otherwise
127
136
  *
128
137
  * @category Constructors
129
138
  */
130
139
  const fromRealOption = exports.fromRealOption = CVInt.fromNumberOption;
131
140
  /**
132
- * Constructs an Either of an Integer from a Real
141
+ * Tries to construct a `CVInteger` from a `CVReal`. Returns a `Right` if the conversion can be
142
+ * performed, a `Left` otherwise
133
143
  *
134
144
  * @category Constructors
135
145
  */
136
146
  const fromReal = exports.fromReal = CVInt.fromNumber;
137
147
  /**
138
- * Constructs an Integer from a Real or throws
148
+ * Constructs a `CVInteger` from a `CVReal` if possible. Throws otherwise
139
149
  *
140
150
  * @category Constructors
141
151
  */
142
152
  const fromRealOrThrow = exports.fromRealOrThrow = CVInt.fromNumberOrThrow;
143
153
  /**
144
- * A Schema that transforms a number into a CVInteger.Type
154
+ * A `Schema` that transforms a number into a `CVInteger`
145
155
  *
146
- * @internal
156
+ * @ignore
147
157
  */
148
158
  const SchemaFromNumber = exports.SchemaFromNumber = /*#__PURE__*/_effect.Schema.Number.pipe(/*#__PURE__*/_effect.Schema.fromBrand(constructor));
149
159
  /**
150
- * A Schema that represents a CVInteger.Type
160
+ * A `Schema` that represents a `CVInteger`
151
161
  *
152
- * @internal
162
+ * @ignore
153
163
  */
154
164
  const SchemaFromSelf = exports.SchemaFromSelf = /*#__PURE__*/_effect.Schema.typeSchema(SchemaFromNumber);
155
165
  //# sourceMappingURL=Integer.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Integer.js","names":["_effect","require","CVInt","_interopRequireWildcard","CVReal","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","moduleTag","exports","constructor","Brand","all","unsafeFromNumber","nominal","fromNumberOption","option","bind","fromNumber","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","flow","Option","flatMap","fromBigDecimal","Either","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","unsafeFromReal","Function","identity","fromRealOption","fromReal","fromRealOrThrow","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Integer.ts"],"sourcesContent":[null],"mappings":";;;;;;AAMA,IAAAA,OAAA,gBAAAC,OAAA;AACA,IAAAC,KAAA,gBAAAC,uBAAA,cAAAF,OAAA;AACA,IAAAG,MAAA,gBAAAD,uBAAA,cAAAF,OAAA;AAAoC,SAAAE,wBAAAE,CAAA,EAAAC,CAAA;EAAA,yBAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA;IAAAE,CAAA,OAAAF,OAAA;EAAA,QAAAJ,uBAAA,YAAAA,CAAAE,CAAA,EAAAC,CAAA;IAAA,KAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA;IAAA,IAAAM,CAAA;MAAAC,CAAA;MAAAC,CAAA;QAAAC,SAAA;QAAAC,OAAA,EAAAV;MAAA;IAAA,aAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA;IAAA,IAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA;MAAA,IAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA;MAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA;IAAA;IAAA,WAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA;IAAA,OAAAO,CAAA;EAAA,GAAAR,CAAA,EAAAC,CAAA;AAAA;AARpC;;;;;AAUA;;;;;AAKO,MAAMkB,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,iCAAiC;AAE1D;;;;;AAKO,MAAME,WAAW,GAAAD,OAAA,CAAAC,WAAA,gBAAG1B,OAAA,CAAA2B,KAAK,CAACC,GAAG,CAACxB,MAAM,CAACsB,WAAW,EAAExB,KAAK,CAACwB,WAAW,CAAC;AAS3E;;;;;AAKO,MAAMG,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,gBAAG7B,OAAA,CAAA2B,KAAK,CAACG,OAAO,EAAQ;AAErD;;;;;AAKO,MAAMC,gBAAgB,GAAAN,OAAA,CAAAM,gBAAA,gBAGzBL,WAAW,CAACM,MAAM,CAACC,IAAI,CAACP,WAAW,CAAC;AAExC;;;;;AAKO,MAAMQ,UAAU,GAAAT,OAAA,CAAAS,UAAA,gBAGnBR,WAAW,CAACS,MAAM,CAACF,IAAI,CAACP,WAAW,CAAC;AAExC;;;;;AAKO,MAAMU,iBAAiB,GAAAX,OAAA,CAAAW,iBAAA,GAAwCV,WAAW;AAEjF;;;;;AAKO,MAAMW,oBAAoB,GAAAZ,OAAA,CAAAY,oBAAA,GAChCjC,MAAM,CAACiC,oBAA6B;AAErC;;;;;AAKO,MAAMC,oBAAoB,GAAAb,OAAA,CAAAa,oBAAA,gBAG7B,IAAAtC,OAAA,CAAAuC,IAAI,EAACnC,MAAM,CAACkC,oBAAoB,eAAEtC,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACvC,KAAK,CAAC6B,gBAAgB,CAAC,CAAU;AAEtF;;;;;AAKO,MAAMW,cAAc,GAAAjB,OAAA,CAAAiB,cAAA,gBAGvB,IAAA1C,OAAA,CAAAuC,IAAI,EAACnC,MAAM,CAACsC,cAAc,eAAE1C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACvC,KAAK,CAACgC,UAAU,CAAC,CAAU;AAE1E;;;;;AAKO,MAAMU,qBAAqB,GAAAnB,OAAA,CAAAmB,qBAAA,gBAAuD,IAAA5C,OAAA,CAAAuC,IAAI,EAC5FnC,MAAM,CAACwC,qBAAqB,EAC5B1C,KAAK,CAACkC,iBAAiB,CACd;AAEV;;;;;AAKO,MAAMS,gBAAgB,GAAApB,OAAA,CAAAoB,gBAAA,GAC5BzC,MAAM,CAACyC,gBAAyB;AAEjC;;;;;AAKO,MAAMC,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,gBAAuD,IAAA9C,OAAA,CAAAuC,IAAI,EACvFnC,MAAM,CAAC0C,gBAAgB,CACd;AAEV;;;;;AAKO,MAAMC,UAAU,GAAAtB,OAAA,CAAAsB,UAAA,gBAGnB,IAAA/C,OAAA,CAAAuC,IAAI,EAACnC,MAAM,CAAC2C,UAAU,eAAE/C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACvC,KAAK,CAACgC,UAAU,CAAC,CAAU;AAEtE;;;;;AAKO,MAAMc,iBAAiB,GAAAvB,OAAA,CAAAuB,iBAAA,gBAAwC,IAAAhD,OAAA,CAAAuC,IAAI,EACzEnC,MAAM,CAAC4C,iBAAiB,CACf;AAEV;;;;;AAKO,MAAMC,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,GAA6CjD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAElG;;;;;AAKO,MAAMC,cAAc,GAAA3B,OAAA,CAAA2B,cAAA,GAGvBlD,KAAK,CAAC6B,gBAAyB;AAEnC;;;;;AAKO,MAAMsB,QAAQ,GAAA5B,OAAA,CAAA4B,QAAA,GAGjBnD,KAAK,CAACgC,UAAmB;AAE7B;;;;;AAKO,MAAMoB,eAAe,GAAA7B,OAAA,CAAA6B,eAAA,GAC3BpD,KAAK,CAACkC,iBAA0B;AAEjC;;;;;AAKO,MAAMmB,gBAAgB,GAAA9B,OAAA,CAAA8B,gBAAA,gBAAgCvD,OAAA,CAAAwD,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9E1D,OAAA,CAAAwD,MAAM,CAACG,SAAS,CAACjC,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMkC,cAAc,GAAAnC,OAAA,CAAAmC,cAAA,gBAAwB5D,OAAA,CAAAwD,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
1
+ {"version":3,"file":"Integer.js","names":["_effect","require","CVInt","_interopRequireWildcard","CVReal","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","moduleTag","exports","constructor","Brand","all","unsafeFromNumber","nominal","fromNumberOption","option","bind","fromNumber","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","flow","Option","flatMap","fromBigDecimal","Either","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","unsafeFromReal","Function","identity","fromRealOption","fromReal","fromRealOrThrow","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Integer.ts"],"sourcesContent":[null],"mappings":";;;;;;AAQA,IAAAA,OAAA,gBAAAC,OAAA;AACA,IAAAC,KAAA,gBAAAC,uBAAA,cAAAF,OAAA;AACA,IAAAG,MAAA,gBAAAD,uBAAA,cAAAF,OAAA;AAAoC,SAAAE,wBAAAE,CAAA,EAAAC,CAAA;EAAA,yBAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA;IAAAE,CAAA,OAAAF,OAAA;EAAA,QAAAJ,uBAAA,YAAAA,CAAAE,CAAA,EAAAC,CAAA;IAAA,KAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA;IAAA,IAAAM,CAAA;MAAAC,CAAA;MAAAC,CAAA;QAAAC,SAAA;QAAAC,OAAA,EAAAV;MAAA;IAAA,aAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA;IAAA,IAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA;MAAA,IAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA;MAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA;IAAA;IAAA,WAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA;IAAA,OAAAO,CAAA;EAAA,GAAAR,CAAA,EAAAC,CAAA;AAAA;AAVpC;;;;;;;AAYA;;;;;AAKO,MAAMkB,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,iCAAiC;AAE1D;;;;;AAKO,MAAME,WAAW,GAAAD,OAAA,CAAAC,WAAA,gBAAG1B,OAAA,CAAA2B,KAAK,CAACC,GAAG,CAACxB,MAAM,CAACsB,WAAW,EAAExB,KAAK,CAACwB,WAAW,CAAC;AAS3E;;;;;AAKO,MAAMG,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,gBAAG7B,OAAA,CAAA2B,KAAK,CAACG,OAAO,EAAQ;AAErD;;;;;;AAMO,MAAMC,gBAAgB,GAAAN,OAAA,CAAAM,gBAAA,gBAGzBL,WAAW,CAACM,MAAM,CAACC,IAAI,CAACP,WAAW,CAAC;AAExC;;;;;;AAMO,MAAMQ,UAAU,GAAAT,OAAA,CAAAS,UAAA,gBAGnBR,WAAW,CAACS,MAAM,CAACF,IAAI,CAACP,WAAW,CAAC;AAExC;;;;;AAKO,MAAMU,iBAAiB,GAAAX,OAAA,CAAAW,iBAAA,GAAwCV,WAAW;AAEjF;;;;;AAKO,MAAMW,oBAAoB,GAAAZ,OAAA,CAAAY,oBAAA,GAChCjC,MAAM,CAACiC,oBAA6B;AAErC;;;;;;AAMO,MAAMC,oBAAoB,GAAAb,OAAA,CAAAa,oBAAA,gBAG7B,IAAAtC,OAAA,CAAAuC,IAAI,EAACnC,MAAM,CAACkC,oBAAoB,eAAEtC,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACvC,KAAK,CAAC6B,gBAAgB,CAAC,CAAU;AAEtF;;;;;;AAMO,MAAMW,cAAc,GAAAjB,OAAA,CAAAiB,cAAA,gBAGvB,IAAA1C,OAAA,CAAAuC,IAAI,EAACnC,MAAM,CAACsC,cAAc,eAAE1C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACvC,KAAK,CAACgC,UAAU,CAAC,CAAU;AAE1E;;;;;AAKO,MAAMU,qBAAqB,GAAAnB,OAAA,CAAAmB,qBAAA,gBAAuD,IAAA5C,OAAA,CAAAuC,IAAI,EAC5FnC,MAAM,CAACwC,qBAAqB,EAC5B1C,KAAK,CAACkC,iBAAiB,CACd;AAEV;;;;;AAKO,MAAMS,gBAAgB,GAAApB,OAAA,CAAAoB,gBAAA,GAC5BzC,MAAM,CAACyC,gBAAyB;AAEjC;;;;;;AAMO,MAAMC,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,gBAAuD,IAAA9C,OAAA,CAAAuC,IAAI,EACvFnC,MAAM,CAAC0C,gBAAgB,CACd;AAEV;;;;;;AAMO,MAAMC,UAAU,GAAAtB,OAAA,CAAAsB,UAAA,gBAGnB,IAAA/C,OAAA,CAAAuC,IAAI,EAACnC,MAAM,CAAC2C,UAAU,eAAE/C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACvC,KAAK,CAACgC,UAAU,CAAC,CAAU;AAEtE;;;;;AAKO,MAAMc,iBAAiB,GAAAvB,OAAA,CAAAuB,iBAAA,gBAAwC,IAAAhD,OAAA,CAAAuC,IAAI,EACzEnC,MAAM,CAAC4C,iBAAiB,CACf;AAEV;;;;;AAKO,MAAMC,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,GAA6CjD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAElG;;;;;;AAMO,MAAMC,cAAc,GAAA3B,OAAA,CAAA2B,cAAA,GAGvBlD,KAAK,CAAC6B,gBAAyB;AAEnC;;;;;;AAMO,MAAMsB,QAAQ,GAAA5B,OAAA,CAAA4B,QAAA,GAGjBnD,KAAK,CAACgC,UAAmB;AAE7B;;;;;AAKO,MAAMoB,eAAe,GAAA7B,OAAA,CAAA6B,eAAA,GAC3BpD,KAAK,CAACkC,iBAA0B;AAEjC;;;;;AAKO,MAAMmB,gBAAgB,GAAA9B,OAAA,CAAA8B,gBAAA,gBAAgCvD,OAAA,CAAAwD,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9E1D,OAAA,CAAAwD,MAAM,CAACG,SAAS,CAACjC,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMkC,cAAc,GAAAnC,OAAA,CAAAmC,cAAA,gBAAwB5D,OAAA,CAAAwD,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
@@ -30,8 +30,8 @@ function _interopRequireWildcard(e, t) {
30
30
  })(e, t);
31
31
  }
32
32
  /**
33
- * This module implements conversions from number to string and string to number in base-10
34
- * notation.
33
+ * This module implements a `CVNumberBase10Format` which describes the possible options to
34
+ * format/parse a base-10 number or `BigDecimal` and implements the formatting/parsing algortithms
35
35
  */
36
36
 
37
37
  /**
@@ -42,7 +42,7 @@ function _interopRequireWildcard(e, t) {
42
42
  const moduleTag = exports.moduleTag = '@parischap/conversions/NumberBase10Format/';
43
43
  const _TypeId = /*#__PURE__*/Symbol.for(moduleTag);
44
44
  /**
45
- * Possible sign display options
45
+ * Type that represents the possible sign display options
46
46
  *
47
47
  * @category Models
48
48
  */
@@ -120,7 +120,7 @@ var SignDisplay;
120
120
  }) => isZero || sign === 1 ? '' : '-'), /*#__PURE__*/_effectLib.MMatch.whenIs(SignDisplay.Never, () => _effectLib.MFunction.constEmptyString), _effectLib.MMatch.exhaustive);
121
121
  })(SignDisplay || (exports.SignDisplay = SignDisplay = {}));
122
122
  /**
123
- * Possible scientific notation options
123
+ * Type that represents the possible scientific notation options
124
124
  *
125
125
  * @category Models
126
126
  */
@@ -159,7 +159,7 @@ var ScientificNotation;
159
159
  ScientificNotation[ScientificNotation["Engineering"] = 3] = "Engineering";
160
160
  })(ScientificNotation || (exports.ScientificNotation = ScientificNotation = {}));
161
161
  /**
162
- * Namespace for possible scientific notation options
162
+ * ScientificNotation namespace
163
163
  *
164
164
  * @category Models
165
165
  */
@@ -273,7 +273,7 @@ const roundingMode = exports.roundingMode = /*#__PURE__*/_effect.Struct.get('rou
273
273
  */
274
274
  const signDisplay = exports.signDisplay = /*#__PURE__*/_effect.Struct.get('signDisplay');
275
275
  /**
276
- * Returns a short description of `self`
276
+ * Returns a short description of `self`, e.g. 'signed integer'
277
277
  *
278
278
  * @category Destructors
279
279
  */
@@ -327,41 +327,41 @@ const _toBigDecimalExtractor = (self, fillChar = '') => {
327
327
  /**
328
328
  * Returns a function that tries to parse, from the start of a string `text`, a number respecting
329
329
  * the options represented by `self` and an optional `fillChar` parameter. If successful, that
330
- * function returns a `some` containing `parsedText` (the part of `text` that could be analyzed as
330
+ * function returns a `Some` containing `parsedText` (the part of `text` that could be analyzed as
331
331
  * representing a number) and `value` (`parsedText` converted to a BigDecimal value). Otherwise, it
332
- * returns a `none`. As there is no way to distinguish `-0n` and `0n` in Javascript, parsing '-0',
333
- * '0', '+0' will yield the same result.
332
+ * returns a `None`. As `BigDecimal`'s provide no possibility to distinguish `-0n` and `0n`, parsing
333
+ * '-0', '0', '+0' will yield the same result.
334
334
  *
335
335
  * `fillChar` is a character that may be used as filler between the sign and the number (or at the
336
336
  * start of the number if it is unsigned). It must be a one-character string (but no error is
337
- * triggered if it's not). You can use '0' as `fillChar` but you shoud not use any other digit
337
+ * triggered if it's not). You can use '0' as `fillChar` but you should not use any other digit
338
338
  * because the value of the number to parse would depend on the number of removed `fillChar`'s.
339
339
  *
340
340
  * @category Parsing
341
341
  */
342
342
  const toBigDecimalExtractor = exports.toBigDecimalExtractor = /*#__PURE__*/(0, _effect.flow)(_toBigDecimalExtractor, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Option.map(([value, parsedText, sign]) => _effect.Tuple.make(_effect.BigDecimal.multiply(value, _effect.BigDecimal.unsafeFromNumber(sign)), parsedText))));
343
343
  /**
344
- * Same as toBigDecimalExtractor but the returned parser throws in case of error
344
+ * Same as `toBigDecimalExtractor` but the returned parser throws in case of failure
345
345
  *
346
346
  * @category Parsing
347
347
  */
348
348
  const toThrowingBigDecimalExtractor = (self, fillChar) => text => (0, _effect.pipe)(text, toBigDecimalExtractor(self, fillChar), _effect.Option.getOrThrowWith(() => new Error(`A BigDecimal could not be parsed from the start of '${text}'`)));
349
349
  /**
350
- * Same as `toBigDecimalExtractor` but returns a `Real` which is the most usual use case.
351
- * Furthermore, this function will return -0 if your parse '-0' and 0 if you parse '0' or '+0'.
350
+ * Same as `toBigDecimalExtractor` but returns a `CVReal`. This is the most usual use case.
351
+ * Furthermore, this function will return `-0` if your parse '-0' and `0` if you parse '0' or '+0'.
352
352
  *
353
353
  * @category Parsing
354
354
  */
355
355
  exports.toThrowingBigDecimalExtractor = toThrowingBigDecimalExtractor;
356
356
  const toRealExtractor = exports.toRealExtractor = /*#__PURE__*/(0, _effect.flow)(_toBigDecimalExtractor, /*#__PURE__*/_effect.Function.compose(/*#__PURE__*/_effect.Option.flatMap(([value, parsedText, sign]) => (0, _effect.pipe)(value, CVReal.fromBigDecimalOption, _effect.Option.map((0, _effect.flow)(_effect.Number.multiply(sign), _effect.Tuple.make, _effect.Tuple.appendElement(parsedText)))))));
357
357
  /**
358
- * Same as toRealExtractor but the returned parser throws in case of error
358
+ * Same as `toRealExtractor` but the returned parser throws in case of failure
359
359
  *
360
360
  * @category Parsing
361
361
  */
362
362
  const toThrowingRealExtractor = (self, fillChar) => text => (0, _effect.pipe)(text, toRealExtractor(self, fillChar), _effect.Option.getOrThrowWith(() => new Error(`A Real could not be parsed from the start of '${text}'`)));
363
363
  /**
364
- * Same as toBigDecimalExtractor but the whole of the input text must represent a number, not just
364
+ * Same as `toBigDecimalExtractor` but the whole of the input text must represent a number, not just
365
365
  * its start
366
366
  *
367
367
  * @category Parsing
@@ -372,7 +372,7 @@ const toBigDecimalParser = (self, fillChar) => {
372
372
  return text => (0, _effect.pipe)(text, extractor, _effect.Option.flatMap((0, _effect.flow)(_effect.Option.liftPredicate((0, _effect.flow)(_effect.Tuple.getSecond, _effect.String.length, _effectLib.MPredicate.strictEquals(text.length))), _effect.Option.map(_effect.Tuple.getFirst))));
373
373
  };
374
374
  /**
375
- * Same as toRealExtractor but the returned parser throws in case of error
375
+ * Same as `toBigDecimalParser` but the returned parser throws in case of failure
376
376
  *
377
377
  * @category Parsing
378
378
  */
@@ -390,7 +390,7 @@ const toRealParser = (self, fillChar) => {
390
390
  return text => (0, _effect.pipe)(text, extractor, _effect.Option.flatMap((0, _effect.flow)(_effect.Option.liftPredicate((0, _effect.flow)(_effect.Tuple.getSecond, _effect.String.length, _effectLib.MPredicate.strictEquals(text.length))), _effect.Option.map(_effect.Tuple.getFirst))));
391
391
  };
392
392
  /**
393
- * Same as toRealParser but the returned parser throws in case of error
393
+ * Same as `toRealParser` but the returned parser throws in case of failure
394
394
  *
395
395
  * @category Parsing
396
396
  */
@@ -398,9 +398,9 @@ exports.toRealParser = toRealParser;
398
398
  const toThrowingRealParser = (self, fillChar) => text => (0, _effect.pipe)(text, toRealParser(self, fillChar), _effect.Option.getOrThrowWith(() => new Error(`A Real could not be parsed from '${text}'`)));
399
399
  /**
400
400
  * Returns a function that tries to format a `number` respecting the options represented by
401
- * `self`and an optional parameter `fillChars`. If successful, that function returns a `some` of the
402
- * formatted number. Otherwise, it returns a `none`. `number` can be of type number or BigDecimal
403
- * for better accuracy. There is a difference between number and BigDecimal (and bigint) regarding
401
+ * `self`and an optional parameter `fillChars`. If successful, that function returns a `Some` of the
402
+ * formatted number. Otherwise, it returns a `None`. `number` can be of type number or `BigDecimal`
403
+ * for better accuracy. There is a difference between number and `BigDecimal` (and bigint) regarding
404
404
  * the sign of 0. In Javascript, Object.is(0,-0) is false whereas Object.is(0n,-0n) is true. So if
405
405
  * the sign of zero is important to you, prefer passing a number to the function. `0` as a
406
406
  * BigDecimal will always be interpreted as a positive `0` as we have no means of knowing if it is
@@ -449,8 +449,8 @@ const toNumberFormatter = (self, fillChars = '') => {
449
449
  };
450
450
  };
451
451
  /**
452
- * Combinator that returns a copy of self with `minimumFractionalDigits` and
453
- * `maximumFractionalDigits` set to `n`. `n` must be a finite positive integer.
452
+ * Returns a copy of `self` with `minimumFractionalDigits` and `maximumFractionalDigits` set to `n`.
453
+ * `n` must be a finite positive integer
454
454
  *
455
455
  * @category Modifiers
456
456
  */
@@ -460,8 +460,8 @@ const withNDecimals = decimalNumber => (0, _effect.flow)(_effectLib.MStruct.appe
460
460
  maximumFractionalDigits: decimalNumber
461
461
  }), make);
462
462
  /**
463
- * Combinator that returns a copy of self with `maximumFractionalDigits` set to `n`. `n` must be a
464
- * positive integer. Pass 0 for an integer format.
463
+ * Returns a copy of `self` with `maximumFractionalDigits` set to `n`. `n` must be a positive
464
+ * integer (`+Infinity` allowed). Pass 0 for an integer format
465
465
  *
466
466
  * @category Modifiers
467
467
  */
@@ -471,8 +471,8 @@ const withMaxNDecimals = maxDecimalNumber => self => (0, _effect.pipe)(self, _ef
471
471
  maximumFractionalDigits: maxDecimalNumber
472
472
  }), make);
473
473
  /**
474
- * Combinator that returns a copy of self with `minimumFractionalDigits` set to `n`. `n` must be a
475
- * finite positive integer.
474
+ * Returns a copy of `self` with `minimumFractionalDigits` set to `n`. `n` must be a finite positive
475
+ * integer
476
476
  *
477
477
  * @category Modifiers
478
478
  */
@@ -482,7 +482,7 @@ const withMinNDecimals = minDecimalNumber => self => (0, _effect.pipe)(self, _ef
482
482
  maximumFractionalDigits: Math.max(self.maximumFractionalDigits, minDecimalNumber)
483
483
  }), make);
484
484
  /**
485
- * Combinator that returns a copy of self with `scientificNotation` set to `None`.
485
+ * Returns a copy of `self` with `scientificNotation` set to `None`
486
486
  *
487
487
  * @category Modifiers
488
488
  */
@@ -491,7 +491,7 @@ const withNoScientificNotation = exports.withNoScientificNotation = /*#__PURE__*
491
491
  scientificNotation: ScientificNotation.None
492
492
  }), make);
493
493
  /**
494
- * Combinator that returns a copy of self with `scientificNotation` set to `Standard`.
494
+ * Returns a copy of `self` with `scientificNotation` set to `Standard`
495
495
  *
496
496
  * @category Modifiers
497
497
  */
@@ -499,7 +499,7 @@ const withStandardScientificNotation = exports.withStandardScientificNotation =
499
499
  scientificNotation: ScientificNotation.Standard
500
500
  }), make);
501
501
  /**
502
- * Combinator that returns a copy of self with `scientificNotation` set to `Normalized`.
502
+ * Returns a copy of `self` with `scientificNotation` set to `Normalized`
503
503
  *
504
504
  * @category Modifiers
505
505
  */
@@ -507,7 +507,7 @@ const withNormalizedScientificNotation = exports.withNormalizedScientificNotatio
507
507
  scientificNotation: ScientificNotation.Normalized
508
508
  }), make);
509
509
  /**
510
- * Combinator that returns a copy of self with `scientificNotation` set to `Engineering`.
510
+ * Returns a copy of `self` with `scientificNotation` set to `Engineering`
511
511
  *
512
512
  * @category Modifiers
513
513
  */
@@ -515,7 +515,7 @@ const withEngineeringScientificNotation = exports.withEngineeringScientificNotat
515
515
  scientificNotation: ScientificNotation.Engineering
516
516
  }), make);
517
517
  /**
518
- * Combinator that returns a copy of self with `thousandSeparator` set to `thousandSeparator`.
518
+ * Returns a copy of `self` with `thousandSeparator` set to `thousandSeparator`
519
519
  *
520
520
  * @category Modifiers
521
521
  */
@@ -523,14 +523,14 @@ const withThousandSeparator = thousandSeparator => (0, _effect.flow)(_effectLib.
523
523
  thousandSeparator
524
524
  }), make);
525
525
  /**
526
- * Combinator that returns a copy of self with `thousandSeparator` set to ''.
526
+ * Returns a copy of `self` with `thousandSeparator` set to ''
527
527
  *
528
528
  * @category Modifiers
529
529
  */
530
530
  exports.withThousandSeparator = withThousandSeparator;
531
531
  const withoutThousandSeparator = exports.withoutThousandSeparator = /*#__PURE__*/withThousandSeparator('');
532
532
  /**
533
- * Combinator that returns a copy of self with `fractionalSeparator` set to `fractionalSeparator`.
533
+ * Returns a copy of `self` with `fractionalSeparator` set to `fractionalSeparator`
534
534
  *
535
535
  * @category Modifiers
536
536
  */
@@ -538,7 +538,7 @@ const withFractionalSeparator = fractionalSeparator => (0, _effect.flow)(_effect
538
538
  fractionalSeparator: fractionalSeparator
539
539
  }), make);
540
540
  /**
541
- * Combinator that returns a copy of self with `signDisplay` set to `Auto`.
541
+ * Returns a copy of `self` with `signDisplay` set to `Auto`
542
542
  *
543
543
  * @category Modifiers
544
544
  */
@@ -547,7 +547,7 @@ const withSignDisplayForNegative = exports.withSignDisplayForNegative = /*#__PUR
547
547
  signDisplay: SignDisplay.Auto
548
548
  }), make);
549
549
  /**
550
- * Combinator that returns a copy of self with `signDisplay` set to `Always`.
550
+ * Returns a copy of `self` with `signDisplay` set to `Always`
551
551
  *
552
552
  * @category Modifiers
553
553
  */
@@ -555,7 +555,7 @@ const withSignDisplay = exports.withSignDisplay = /*#__PURE__*/(0, _effect.flow)
555
555
  signDisplay: SignDisplay.Always
556
556
  }), make);
557
557
  /**
558
- * Combinator that returns a copy of self with `signDisplay` set to `ExceptZero`.
558
+ * Returns a copy of `self` with `signDisplay` set to `ExceptZero`
559
559
  *
560
560
  * @category Modifiers
561
561
  */
@@ -563,7 +563,7 @@ const withSignDisplayExceptZero = exports.withSignDisplayExceptZero = /*#__PURE_
563
563
  signDisplay: SignDisplay.ExceptZero
564
564
  }), make);
565
565
  /**
566
- * Combinator that returns a copy of self with `signDisplay` set to `Negative`.
566
+ * Returns a copy of `self` with `signDisplay` set to `Negative`
567
567
  *
568
568
  * @category Modifiers
569
569
  */
@@ -571,7 +571,7 @@ const withSignDisplayForNegativeExceptZero = exports.withSignDisplayForNegativeE
571
571
  signDisplay: SignDisplay.Negative
572
572
  }), make);
573
573
  /**
574
- * Combinator that returns a copy of self with `signDisplay` set to `Never`.
574
+ * Returns a copy of `self` with `signDisplay` set to `Never`
575
575
  *
576
576
  * @category Modifiers
577
577
  */
@@ -579,7 +579,7 @@ const withoutSignDisplay = exports.withoutSignDisplay = /*#__PURE__*/(0, _effect
579
579
  signDisplay: SignDisplay.Never
580
580
  }), make);
581
581
  /**
582
- * Combinator that returns a copy of self with `roundingMode` set to `Ceil`.
582
+ * Returns a copy of `self` with `roundingMode` set to `Ceil`
583
583
  *
584
584
  * @category Modifiers
585
585
  */
@@ -587,7 +587,7 @@ const withCeilRoundingMode = exports.withCeilRoundingMode = /*#__PURE__*/(0, _ef
587
587
  roundingMode: CVRoundingMode.Type.Ceil
588
588
  }), make);
589
589
  /**
590
- * Combinator that returns a copy of self with `roundingMode` set to `Floor`.
590
+ * Returns a copy of `self` with `roundingMode` set to `Floor`
591
591
  *
592
592
  * @category Modifiers
593
593
  */
@@ -595,7 +595,7 @@ const withFloorRoundingMode = exports.withFloorRoundingMode = /*#__PURE__*/(0, _
595
595
  roundingMode: CVRoundingMode.Type.Floor
596
596
  }), make);
597
597
  /**
598
- * Combinator that returns a copy of self with `roundingMode` set to `Expand`.
598
+ * Returns a copy of `self` with `roundingMode` set to `Expand`
599
599
  *
600
600
  * @category Modifiers
601
601
  */
@@ -603,7 +603,7 @@ const withExpandRoundingMode = exports.withExpandRoundingMode = /*#__PURE__*/(0,
603
603
  roundingMode: CVRoundingMode.Type.Expand
604
604
  }), make);
605
605
  /**
606
- * Combinator that returns a copy of self with `roundingMode` set to `Trunc`.
606
+ * Returns a copy of `self` with `roundingMode` set to `Trunc`
607
607
  *
608
608
  * @category Modifiers
609
609
  */
@@ -611,7 +611,7 @@ const withTruncRoundingMode = exports.withTruncRoundingMode = /*#__PURE__*/(0, _
611
611
  roundingMode: CVRoundingMode.Type.Trunc
612
612
  }), make);
613
613
  /**
614
- * Combinator that returns a copy of self with `roundingMode` set to `HalfCeil`.
614
+ * Returns a copy of `self` with `roundingMode` set to `HalfCeil`
615
615
  *
616
616
  * @category Modifiers
617
617
  */
@@ -619,7 +619,7 @@ const withHalfCeilRoundingMode = exports.withHalfCeilRoundingMode = /*#__PURE__*
619
619
  roundingMode: CVRoundingMode.Type.HalfCeil
620
620
  }), make);
621
621
  /**
622
- * Combinator that returns a copy of self with `roundingMode` set to `HalfFloor`.
622
+ * Returns a copy of `self` with `roundingMode` set to `HalfFloor`
623
623
  *
624
624
  * @category Modifiers
625
625
  */
@@ -627,7 +627,7 @@ const withHalfFloorRoundingMode = exports.withHalfFloorRoundingMode = /*#__PURE_
627
627
  roundingMode: CVRoundingMode.Type.HalfFloor
628
628
  }), make);
629
629
  /**
630
- * Combinator that returns a copy of self with `roundingMode` set to `HalfExpand`.
630
+ * Returns a copy of `self` with `roundingMode` set to `HalfExpand`
631
631
  *
632
632
  * @category Modifiers
633
633
  */
@@ -635,7 +635,7 @@ const withHalfExpandRoundingMode = exports.withHalfExpandRoundingMode = /*#__PUR
635
635
  roundingMode: CVRoundingMode.Type.HalfExpand
636
636
  }), make);
637
637
  /**
638
- * Combinator that returns a copy of self with `roundingMode` set to `HalfTrunc`.
638
+ * Returns a copy of `self` with `roundingMode` set to `HalfTrunc`
639
639
  *
640
640
  * @category Modifiers
641
641
  */
@@ -643,7 +643,7 @@ const withHalfTruncRoundingMode = exports.withHalfTruncRoundingMode = /*#__PURE_
643
643
  roundingMode: CVRoundingMode.Type.HalfTrunc
644
644
  }), make);
645
645
  /**
646
- * Combinator that returns a copy of self with `roundingMode` set to `HalfEven`.
646
+ * Returns a copy of `self` with `roundingMode` set to `HalfEven`
647
647
  *
648
648
  * @category Modifiers
649
649
  */
@@ -651,7 +651,7 @@ const withHalfEvenRoundingMode = exports.withHalfEvenRoundingMode = /*#__PURE__*
651
651
  roundingMode: CVRoundingMode.Type.HalfEven
652
652
  }), make);
653
653
  /**
654
- * Combinator that returns a copy of self with `showNullIntegerPart` set to `false`.
654
+ * Returns a copy of `self` with `showNullIntegerPart` set to `false`
655
655
  *
656
656
  * @category Modifiers
657
657
  */
@@ -659,7 +659,7 @@ const withNullIntegerPartNotShowing = exports.withNullIntegerPartNotShowing = /*
659
659
  showNullIntegerPart: false
660
660
  }), make);
661
661
  /**
662
- * Combinator that returns a copy of self with `showNullIntegerPart` set to `true`.
662
+ * Returns a copy of `self` with `showNullIntegerPart` set to `true`
663
663
  *
664
664
  * @category Modifiers
665
665
  */
@@ -667,7 +667,7 @@ const withNullIntegerPartShowing = exports.withNullIntegerPartShowing = /*#__PUR
667
667
  showNullIntegerPart: true
668
668
  }), make);
669
669
  /**
670
- * NumberBase10Format instance that uses a comma as fractional separator, a space as thousand
670
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, a space as thousand
671
671
  * separator and shows at most three fractional digits. Used in countries like France,
672
672
  * French-speaking Canada, French-speaking Belgium, Denmark, Finland, Sweden...
673
673
  *
@@ -685,22 +685,22 @@ const frenchStyleNumber = exports.frenchStyleNumber = /*#__PURE__*/make({
685
685
  signDisplay: SignDisplay.Negative
686
686
  });
687
687
  /**
688
- * NumberBase10Format instance that uses a comma as fractional separator, no thousand separator and
689
- * shows at most three fractional digits. Used in countries like France, French-speaking Canada,
688
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, no thousand separator
689
+ * and shows at most three fractional digits. Used in countries like France, French-speaking Canada,
690
690
  * French-speaking Belgium, Denmark, Finland, Sweden...
691
691
  *
692
692
  * @category Instances
693
693
  */
694
694
  const frenchStyleUngroupedNumber = exports.frenchStyleUngroupedNumber = /*#__PURE__*/(0, _effect.pipe)(frenchStyleNumber, withoutThousandSeparator);
695
695
  /**
696
- * French-style integer NumberBase10Format instance. Used in countries like France, French-speaking
697
- * Canada, French-speaking Belgium, Denmark, Finland, Sweden...
696
+ * French-style integer `CVNumberBase10Format` instance. Used in countries like France,
697
+ * French-speaking Canada, French-speaking Belgium, Denmark, Finland, Sweden...
698
698
  *
699
699
  * @category Instances
700
700
  */
701
701
  const frenchStyleInteger = exports.frenchStyleInteger = /*#__PURE__*/(0, _effect.pipe)(frenchStyleNumber, /*#__PURE__*/withMaxNDecimals(0));
702
702
  /**
703
- * NumberBase10Format instance that uses a comma as fractional separator, a dot as thousand
703
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, a dot as thousand
704
704
  * separator and shows at most three fractional digits. Used in countries like Dutch-speaking
705
705
  * Belgium, the Netherlands, Germany, Italy, Norway, Croatia, Spain...
706
706
  *
@@ -710,22 +710,22 @@ const dutchStyleNumber = exports.dutchStyleNumber = /*#__PURE__*/(0, _effect.pip
710
710
  thousandSeparator: '.'
711
711
  }), make);
712
712
  /**
713
- * NumberBase10Format instance that uses a comma as fractional separator, no thousand separator and
714
- * shows at most three fractional digits. Used in countries like Dutch-speaking Belgium, the
713
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, no thousand separator
714
+ * and shows at most three fractional digits. Used in countries like Dutch-speaking Belgium, the
715
715
  * Netherlands, Germany, Italy, Norway, Croatia, Spain...
716
716
  *
717
717
  * @category Instances
718
718
  */
719
719
  const dutchStyleUngroupedNumber = exports.dutchStyleUngroupedNumber = /*#__PURE__*/(0, _effect.pipe)(dutchStyleNumber, withoutThousandSeparator);
720
720
  /**
721
- * Dutch-style integer NumberBase10Format instance. Used in countries like Dutch-speaking Belgium,
722
- * the Netherlands, Germany, Italy, Norway, Croatia, Spain...
721
+ * Dutch-style integer `CVNumberBase10Format` instance. Used in countries like Dutch-speaking
722
+ * Belgium, the Netherlands, Germany, Italy, Norway, Croatia, Spain...
723
723
  *
724
724
  * @category Instances
725
725
  */
726
726
  const dutchStyleInteger = exports.dutchStyleInteger = /*#__PURE__*/(0, _effect.pipe)(dutchStyleNumber, /*#__PURE__*/withMaxNDecimals(0));
727
727
  /**
728
- * NumberBase10Format instance that uses a dot as fractional separator, a comma as thousand
728
+ * `CVNumberBase10Format` instance that uses a dot as fractional separator, a comma as thousand
729
729
  * separator and shows at most three fractional digits. Used in countries like the UK, the US,
730
730
  * English-speaking Canada, Australia, Thaïland, Bosnia...
731
731
  *
@@ -736,22 +736,22 @@ const ukStyleNumber = exports.ukStyleNumber = /*#__PURE__*/(0, _effect.pipe)(fre
736
736
  thousandSeparator: ','
737
737
  }), make);
738
738
  /**
739
- * NumberBase10Format instance that uses a dot as fractional separator, no thousand separator and
740
- * shows at most three fractional digits. Used in countries like the UK, the US, English-speaking
741
- * Canada, Australia, Thaïland, Bosnia...
739
+ * `CVNumberBase10Format` instance that uses a dot as fractional separator, no thousand separator
740
+ * and shows at most three fractional digits. Used in countries like the UK, the US,
741
+ * English-speaking Canada, Australia, Thaïland, Bosnia...
742
742
  *
743
743
  * @category Instances
744
744
  */
745
745
  const ukStyleUngroupedNumber = exports.ukStyleUngroupedNumber = /*#__PURE__*/(0, _effect.pipe)(ukStyleNumber, withoutThousandSeparator);
746
746
  /**
747
- * Uk-style integer NumberBase10Format instance. Used in countries like the UK, the US,
747
+ * Uk-style integer `CVNumberBase10Format` instance. Used in countries like the UK, the US,
748
748
  * English-speaking Canada, Australia, Thaïland, Bosnia...
749
749
  *
750
750
  * @category Instances
751
751
  */
752
752
  const ukStyleInteger = exports.ukStyleInteger = /*#__PURE__*/(0, _effect.pipe)(ukStyleNumber, /*#__PURE__*/withMaxNDecimals(0));
753
753
  /**
754
- * Integer NumberBase10Format instance with no thousand separator
754
+ * Integer `CVNumberBase10Format` instance with no thousand separator
755
755
  *
756
756
  * @category Instances
757
757
  */