@parischap/conversions 0.1.0 → 0.3.0

package/esm/Integer.js

@@ -1,6 +1,8 @@
 /**
- * This module implements a finite integer brand (Infinity, NaN or non-null fractional part
- * disallowed)
+ * This module implements a CVInteger brand, i.e. a number that represents an integer (Infinity, NaN
+ * disallowed). Can be used to represent a floor in a lift, a signed quantity... See the `Effect`
+ * documentation about Branding (https://effect.website/docs/code-style/branded-types/) if you are
+ * not familiar with this concept.
  */
 import { Brand, Either, flow, Function, Option, Schema } from 'effect';
 import * as CVInt from './internal/Int.js';
@@ -14,115 +16,123 @@ export const moduleTag = '@parischap/conversions/Integer/';
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 export const constructor = /*#__PURE__*/Brand.all(CVReal.constructor, CVInt.constructor);
 /**
- * Constructs an Integer from a number without any verifications
+ * Constructs a `CVInteger` from a number without any verifications
  *
  * @category Constructors
  */
 export const unsafeFromNumber = /*#__PURE__*/Brand.nominal();
 /**
- * Constructs an Option of an Integer from a number
+ * Tries to construct a `CVInteger` from a number. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromNumberOption = /*#__PURE__*/constructor.option.bind(constructor);
 /**
- * Constructs an Either of an Integer from a number
+ * Tries to construct a `CVnteger` from a number. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromNumber = /*#__PURE__*/constructor.either.bind(constructor);
 /**
- * Constructs an Integer from a number or throws
+ * Constructs a `CVInteger` from a number if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromNumberOrThrow = constructor;
 /**
- * Constructs an Integer from a BigDecimal without any checks
+ * Constructs a `CVInteger` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigDecimal = CVReal.unsafeFromBigDecimal;
 /**
- * Constructs an Option of an Integer from a BigDecimal
+ * Tries to construct a `CVInteger` from a `BigDecimal`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOption = /*#__PURE__*/flow(CVReal.fromBigDecimalOption, /*#__PURE__*/Option.flatMap(CVInt.fromNumberOption));
 /**
- * Constructs an Either of an Integer from a BigDecimal
+ * Tries to construct a `CVInteger` from a `BigDecimal`. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimal = /*#__PURE__*/flow(CVReal.fromBigDecimal, /*#__PURE__*/Either.flatMap(CVInt.fromNumber));
 /**
- * Constructs an Integer from a BigDecimal or throws
+ * Constructs a `CVInteger` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOrThrow = /*#__PURE__*/flow(CVReal.fromBigDecimalOrThrow, CVInt.fromNumberOrThrow);
 /**
- * Constructs an Integer from a BigInt without any checks
+ * Constructs a `CVInteger` from a `BigInt` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigInt = CVReal.unsafeFromBigInt;
 /**
- * Constructs an Option of an Integer from a BigInt
+ * Tries to construct a `CVInteger` from a `BigInt`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOption = /*#__PURE__*/flow(CVReal.fromBigIntOption);
 /**
- * Constructs an Either of an Integer from a BigInt
+ * Tries to construct a `CVInteger` from a `BigInt`. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromBigInt = /*#__PURE__*/flow(CVReal.fromBigInt, /*#__PURE__*/Either.flatMap(CVInt.fromNumber));
 /**
- * Constructs an Integer from a BigInt or throws
+ * Constructs a `CVInteger` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOrThrow = /*#__PURE__*/flow(CVReal.fromBigIntOrThrow);
 /**
- * Constructs an Integer from a Real without any checks
+ * Constructs a `CVInteger` from a `CVReal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromReal = Function.identity;
 /**
- * Constructs an Option of an Integer from a Real
+ * Tries to construct a `CVInteger` from a `CVReal`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromRealOption = CVInt.fromNumberOption;
 /**
- * Constructs an Either of an Integer from a Real
+ * Tries to construct a `CVInteger` from a `CVReal`. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromReal = CVInt.fromNumber;
 /**
- * Constructs an Integer from a Real or throws
+ * Constructs a `CVInteger` from a `CVReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromRealOrThrow = CVInt.fromNumberOrThrow;
 /**
- * A Schema that transforms a number into a CVInteger.Type
+ * A `Schema` that transforms a number into a `CVInteger`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromNumber = /*#__PURE__*/Schema.Number.pipe(/*#__PURE__*/Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVInteger.Type
+ * A `Schema` that represents a `CVInteger`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromSelf = /*#__PURE__*/Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=Integer.js.map

package/esm/Integer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Integer.js","names":["Brand","Either","flow","Function","Option","Schema","CVInt","CVReal","moduleTag","constructor","all","unsafeFromNumber","nominal","fromNumberOption","option","bind","fromNumber","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","flatMap","fromBigDecimal","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","unsafeFromReal","identity","fromRealOption","fromReal","fromRealOrThrow","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Integer.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;AAMA,SAAqBA,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,QAAQ,QAAQ;AAClF,OAAO,KAAKC,KAAK,MAAM,mBAAmB;AAC1C,OAAO,KAAKC,MAAM,MAAM,WAAW;AAEnC;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,iCAAiC;AAE1D;;;;;AAKA,OAAO,MAAMC,WAAW,gBAAGT,KAAK,CAACU,GAAG,CAACH,MAAM,CAACE,WAAW,EAAEH,KAAK,CAACG,WAAW,CAAC;AAS3E;;;;;AAKA,OAAO,MAAME,gBAAgB,gBAAGX,KAAK,CAACY,OAAO,EAAQ;AAErD;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAGzBJ,WAAW,CAACK,MAAM,CAACC,IAAI,CAACN,WAAW,CAAC;AAExC;;;;;AAKA,OAAO,MAAMO,UAAU,gBAGnBP,WAAW,CAACQ,MAAM,CAACF,IAAI,CAACN,WAAW,CAAC;AAExC;;;;;AAKA,OAAO,MAAMS,iBAAiB,GAAwCT,WAAW;AAEjF;;;;;AAKA,OAAO,MAAMU,oBAAoB,GAChCZ,MAAM,CAACY,oBAA6B;AAErC;;;;;AAKA,OAAO,MAAMC,oBAAoB,gBAG7BlB,IAAI,CAACK,MAAM,CAACa,oBAAoB,eAAEhB,MAAM,CAACiB,OAAO,CAACf,KAAK,CAACO,gBAAgB,CAAC,CAAU;AAEtF;;;;;AAKA,OAAO,MAAMS,cAAc,gBAGvBpB,IAAI,CAACK,MAAM,CAACe,cAAc,eAAErB,MAAM,CAACoB,OAAO,CAACf,KAAK,CAACU,UAAU,CAAC,CAAU;AAE1E;;;;;AAKA,OAAO,MAAMO,qBAAqB,gBAAuDrB,IAAI,CAC5FK,MAAM,CAACgB,qBAAqB,EAC5BjB,KAAK,CAACY,iBAAiB,CACd;AAEV;;;;;AAKA,OAAO,MAAMM,gBAAgB,GAC5BjB,MAAM,CAACiB,gBAAyB;AAEjC;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAuDvB,IAAI,CACvFK,MAAM,CAACkB,gBAAgB,CACd;AAEV;;;;;AAKA,OAAO,MAAMC,UAAU,gBAGnBxB,IAAI,CAACK,MAAM,CAACmB,UAAU,eAAEzB,MAAM,CAACoB,OAAO,CAACf,KAAK,CAACU,UAAU,CAAC,CAAU;AAEtE;;;;;AAKA,OAAO,MAAMW,iBAAiB,gBAAwCzB,IAAI,CACzEK,MAAM,CAACoB,iBAAiB,CACf;AAEV;;;;;AAKA,OAAO,MAAMC,cAAc,GAA6CzB,QAAQ,CAAC0B,QAAiB;AAElG;;;;;AAKA,OAAO,MAAMC,cAAc,GAGvBxB,KAAK,CAACO,gBAAyB;AAEnC;;;;;AAKA,OAAO,MAAMkB,QAAQ,GAGjBzB,KAAK,CAACU,UAAmB;AAE7B;;;;;AAKA,OAAO,MAAMgB,eAAe,GAC3B1B,KAAK,CAACY,iBAA0B;AAEjC;;;;;AAKA,OAAO,MAAMe,gBAAgB,gBAAgC5B,MAAM,CAAC6B,MAAM,CAACC,IAAI,cAC9E9B,MAAM,CAAC+B,SAAS,CAAC3B,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAM4B,cAAc,gBAAwBhC,MAAM,CAACiC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"Integer.js","names":["Brand","Either","flow","Function","Option","Schema","CVInt","CVReal","moduleTag","constructor","all","unsafeFromNumber","nominal","fromNumberOption","option","bind","fromNumber","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","flatMap","fromBigDecimal","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","unsafeFromReal","identity","fromRealOption","fromReal","fromRealOrThrow","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Integer.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;AAQA,SAAqBA,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,QAAQ,QAAQ;AAClF,OAAO,KAAKC,KAAK,MAAM,mBAAmB;AAC1C,OAAO,KAAKC,MAAM,MAAM,WAAW;AAEnC;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,iCAAiC;AAE1D;;;;;AAKA,OAAO,MAAMC,WAAW,gBAAGT,KAAK,CAACU,GAAG,CAACH,MAAM,CAACE,WAAW,EAAEH,KAAK,CAACG,WAAW,CAAC;AAS3E;;;;;AAKA,OAAO,MAAME,gBAAgB,gBAAGX,KAAK,CAACY,OAAO,EAAQ;AAErD;;;;;;AAMA,OAAO,MAAMC,gBAAgB,gBAGzBJ,WAAW,CAACK,MAAM,CAACC,IAAI,CAACN,WAAW,CAAC;AAExC;;;;;;AAMA,OAAO,MAAMO,UAAU,gBAGnBP,WAAW,CAACQ,MAAM,CAACF,IAAI,CAACN,WAAW,CAAC;AAExC;;;;;AAKA,OAAO,MAAMS,iBAAiB,GAAwCT,WAAW;AAEjF;;;;;AAKA,OAAO,MAAMU,oBAAoB,GAChCZ,MAAM,CAACY,oBAA6B;AAErC;;;;;;AAMA,OAAO,MAAMC,oBAAoB,gBAG7BlB,IAAI,CAACK,MAAM,CAACa,oBAAoB,eAAEhB,MAAM,CAACiB,OAAO,CAACf,KAAK,CAACO,gBAAgB,CAAC,CAAU;AAEtF;;;;;;AAMA,OAAO,MAAMS,cAAc,gBAGvBpB,IAAI,CAACK,MAAM,CAACe,cAAc,eAAErB,MAAM,CAACoB,OAAO,CAACf,KAAK,CAACU,UAAU,CAAC,CAAU;AAE1E;;;;;AAKA,OAAO,MAAMO,qBAAqB,gBAAuDrB,IAAI,CAC5FK,MAAM,CAACgB,qBAAqB,EAC5BjB,KAAK,CAACY,iBAAiB,CACd;AAEV;;;;;AAKA,OAAO,MAAMM,gBAAgB,GAC5BjB,MAAM,CAACiB,gBAAyB;AAEjC;;;;;;AAMA,OAAO,MAAMC,gBAAgB,gBAAuDvB,IAAI,CACvFK,MAAM,CAACkB,gBAAgB,CACd;AAEV;;;;;;AAMA,OAAO,MAAMC,UAAU,gBAGnBxB,IAAI,CAACK,MAAM,CAACmB,UAAU,eAAEzB,MAAM,CAACoB,OAAO,CAACf,KAAK,CAACU,UAAU,CAAC,CAAU;AAEtE;;;;;AAKA,OAAO,MAAMW,iBAAiB,gBAAwCzB,IAAI,CACzEK,MAAM,CAACoB,iBAAiB,CACf;AAEV;;;;;AAKA,OAAO,MAAMC,cAAc,GAA6CzB,QAAQ,CAAC0B,QAAiB;AAElG;;;;;;AAMA,OAAO,MAAMC,cAAc,GAGvBxB,KAAK,CAACO,gBAAyB;AAEnC;;;;;;AAMA,OAAO,MAAMkB,QAAQ,GAGjBzB,KAAK,CAACU,UAAmB;AAE7B;;;;;AAKA,OAAO,MAAMgB,eAAe,GAC3B1B,KAAK,CAACY,iBAA0B;AAEjC;;;;;AAKA,OAAO,MAAMe,gBAAgB,gBAAgC5B,MAAM,CAAC6B,MAAM,CAACC,IAAI,cAC9E9B,MAAM,CAAC+B,SAAS,CAAC3B,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAM4B,cAAc,gBAAwBhC,MAAM,CAACiC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}

package/esm/NumberBase10Format.js

@@ -1,6 +1,6 @@
 /**
- * This module implements conversions from number to string and string to number in base-10
- * notation.
+ * This module implements a `CVNumberBase10Format` which describes the possible options to
+ * format/parse a base-10 number or `BigDecimal` and implements the formatting/parsing algortithms
  */
 import { MBigDecimal, MBigInt, MFunction, MInspectable, MMatch, MNumber, MPipeable, MPredicate, MRegExpString, MString, MStruct, MTypes } from '@parischap/effect-lib';
 import { Array, BigDecimal, BigInt, Either, flow, Function, Number, Option, pipe, Predicate, String, Struct, Tuple } from 'effect';
@@ -15,7 +15,7 @@ import * as CVRoundingOption from './RoundingOption.js';
 export const moduleTag = '@parischap/conversions/NumberBase10Format/';
 const _TypeId = /*#__PURE__*/Symbol.for(moduleTag);
 /**
- * Possible sign display options
+ * Type that represents the possible sign display options
  *
  * @category Models
  */
@@ -93,7 +93,7 @@ export var SignDisplay;
   }) => isZero || sign === 1 ? '' : '-'), /*#__PURE__*/MMatch.whenIs(SignDisplay.Never, () => MFunction.constEmptyString), MMatch.exhaustive);
 })(SignDisplay || (SignDisplay = {}));
 /**
- * Possible scientific notation options
+ * Type that represents the possible scientific notation options
  *
  * @category Models
  */
@@ -132,7 +132,7 @@ export var ScientificNotation;
   ScientificNotation[ScientificNotation["Engineering"] = 3] = "Engineering";
 })(ScientificNotation || (ScientificNotation = {}));
 /**
- * Namespace for possible scientific notation options
+ * ScientificNotation namespace
  *
  * @category Models
  */
@@ -244,7 +244,7 @@ export const roundingMode = /*#__PURE__*/Struct.get('roundingMode');
  */
 export const signDisplay = /*#__PURE__*/Struct.get('signDisplay');
 /**
- * Returns a short description of `self`
+ * Returns a short description of `self`, e.g. 'signed integer'
  *
  * @category Destructors
  */
@@ -297,40 +297,40 @@ const _toBigDecimalExtractor = (self, fillChar = '') => {
 /**
  * Returns a function that tries to parse, from the start of a string `text`, a number respecting
  * the options represented by `self` and an optional `fillChar` parameter. If successful, that
- * function returns a `some` containing `parsedText` (the part of `text` that could be analyzed as
+ * function returns a `Some` containing `parsedText` (the part of `text` that could be analyzed as
  * representing a number) and `value` (`parsedText` converted to a BigDecimal value). Otherwise, it
- * returns a `none`. As there is no way to distinguish `-0n` and `0n` in Javascript, parsing '-0',
- * '0', '+0' will yield the same result.
+ * returns a `None`. As `BigDecimal`'s provide no possibility to distinguish `-0n` and `0n`, parsing
+ * '-0', '0', '+0' will yield the same result.
  *
  * `fillChar` is a character that may be used as filler between the sign and the number (or at the
  * start of the number if it is unsigned). It must be a one-character string (but no error is
- * triggered if it's not). You can use '0' as `fillChar` but you shoud not use any other digit
+ * triggered if it's not). You can use '0' as `fillChar` but you should not use any other digit
  * because the value of the number to parse would depend on the number of removed `fillChar`'s.
  *
  * @category Parsing
  */
 export const toBigDecimalExtractor = /*#__PURE__*/flow(_toBigDecimalExtractor, /*#__PURE__*/Function.compose(/*#__PURE__*/Option.map(([value, parsedText, sign]) => Tuple.make(BigDecimal.multiply(value, BigDecimal.unsafeFromNumber(sign)), parsedText))));
 /**
- * Same as toBigDecimalExtractor but the returned parser throws in case of error
+ * Same as `toBigDecimalExtractor` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
 export const toThrowingBigDecimalExtractor = (self, fillChar) => text => pipe(text, toBigDecimalExtractor(self, fillChar), Option.getOrThrowWith(() => new Error(`A BigDecimal could not be parsed from the start of '${text}'`)));
 /**
- * Same as `toBigDecimalExtractor` but returns a `Real` which is the most usual use case.
- * Furthermore, this function will return -0 if your parse '-0' and 0 if you parse '0' or '+0'.
+ * Same as `toBigDecimalExtractor` but returns a `CVReal`. This is the most usual use case.
+ * Furthermore, this function will return `-0` if your parse '-0' and `0` if you parse '0' or '+0'.
  *
  * @category Parsing
  */
 export const toRealExtractor = /*#__PURE__*/flow(_toBigDecimalExtractor, /*#__PURE__*/Function.compose(/*#__PURE__*/Option.flatMap(([value, parsedText, sign]) => pipe(value, CVReal.fromBigDecimalOption, Option.map(flow(Number.multiply(sign), Tuple.make, Tuple.appendElement(parsedText)))))));
 /**
- * Same as toRealExtractor but the returned parser throws in case of error
+ * Same as `toRealExtractor` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
 export const toThrowingRealExtractor = (self, fillChar) => text => pipe(text, toRealExtractor(self, fillChar), Option.getOrThrowWith(() => new Error(`A Real could not be parsed from the start of '${text}'`)));
 /**
- * Same as toBigDecimalExtractor but the whole of the input text must represent a number, not just
+ * Same as `toBigDecimalExtractor` but the whole of the input text must represent a number, not just
  * its start
  *
  * @category Parsing
@@ -340,7 +340,7 @@ export const toBigDecimalParser = (self, fillChar) => {
   return text => pipe(text, extractor, Option.flatMap(flow(Option.liftPredicate(flow(Tuple.getSecond, String.length, MPredicate.strictEquals(text.length))), Option.map(Tuple.getFirst))));
 };
 /**
- * Same as toRealExtractor but the returned parser throws in case of error
+ * Same as `toBigDecimalParser` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
@@ -356,16 +356,16 @@ export const toRealParser = (self, fillChar) => {
   return text => pipe(text, extractor, Option.flatMap(flow(Option.liftPredicate(flow(Tuple.getSecond, String.length, MPredicate.strictEquals(text.length))), Option.map(Tuple.getFirst))));
 };
 /**
- * Same as toRealParser but the returned parser throws in case of error
+ * Same as `toRealParser` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
 export const toThrowingRealParser = (self, fillChar) => text => pipe(text, toRealParser(self, fillChar), Option.getOrThrowWith(() => new Error(`A Real could not be parsed from '${text}'`)));
 /**
  * Returns a function that tries to format a `number` respecting the options represented by
- * `self`and an optional parameter `fillChars`. If successful, that function returns a `some` of the
- * formatted number. Otherwise, it returns a `none`. `number` can be of type number or BigDecimal
- * for better accuracy. There is a difference between number and BigDecimal (and bigint) regarding
+ * `self`and an optional parameter `fillChars`. If successful, that function returns a `Some` of the
+ * formatted number. Otherwise, it returns a `None`. `number` can be of type number or `BigDecimal`
+ * for better accuracy. There is a difference between number and `BigDecimal` (and bigint) regarding
  * the sign of 0. In Javascript, Object.is(0,-0) is false whereas Object.is(0n,-0n) is true. So if
  * the sign of zero is important to you, prefer passing a number to the function. `0` as a
  * BigDecimal will always be interpreted as a positive `0` as we have no means of knowing if it is
@@ -413,8 +413,8 @@ export const toNumberFormatter = (self, fillChars = '') => {
   };
 };
 /**
- * Combinator that returns a copy of self with `minimumFractionalDigits` and
- * `maximumFractionalDigits` set to `n`. `n` must be a finite positive integer.
+ * Returns a copy of `self` with `minimumFractionalDigits` and `maximumFractionalDigits` set to `n`.
+ * `n` must be a finite positive integer
  *
  * @category Modifiers
  */
@@ -423,8 +423,8 @@ export const withNDecimals = decimalNumber => flow(MStruct.append({
   maximumFractionalDigits: decimalNumber
 }), make);
 /**
- * Combinator that returns a copy of self with `maximumFractionalDigits` set to `n`. `n` must be a
- * positive integer. Pass 0 for an integer format.
+ * Returns a copy of `self` with `maximumFractionalDigits` set to `n`. `n` must be a positive
+ * integer (`+Infinity` allowed). Pass 0 for an integer format
  *
  * @category Modifiers
  */
@@ -433,8 +433,8 @@ export const withMaxNDecimals = maxDecimalNumber => self => pipe(self, MStruct.a
   maximumFractionalDigits: maxDecimalNumber
 }), make);
 /**
- * Combinator that returns a copy of self with `minimumFractionalDigits` set to `n`. `n` must be a
- * finite positive integer.
+ * Returns a copy of `self` with `minimumFractionalDigits` set to `n`. `n` must be a finite positive
+ * integer
  *
  * @category Modifiers
  */
@@ -443,7 +443,7 @@ export const withMinNDecimals = minDecimalNumber => self => pipe(self, MStruct.a
   maximumFractionalDigits: Math.max(self.maximumFractionalDigits, minDecimalNumber)
 }), make);
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `None`.
+ * Returns a copy of `self` with `scientificNotation` set to `None`
  *
  * @category Modifiers
  */
@@ -451,7 +451,7 @@ export const withNoScientificNotation = /*#__PURE__*/flow(/*#__PURE__*/MStruct.a
   scientificNotation: ScientificNotation.None
 }), make);
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `Standard`.
+ * Returns a copy of `self` with `scientificNotation` set to `Standard`
  *
  * @category Modifiers
  */
@@ -459,7 +459,7 @@ export const withStandardScientificNotation = /*#__PURE__*/flow(/*#__PURE__*/MSt
   scientificNotation: ScientificNotation.Standard
 }), make);
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `Normalized`.
+ * Returns a copy of `self` with `scientificNotation` set to `Normalized`
  *
  * @category Modifiers
  */
@@ -467,7 +467,7 @@ export const withNormalizedScientificNotation = /*#__PURE__*/flow(/*#__PURE__*/M
   scientificNotation: ScientificNotation.Normalized
 }), make);
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `Engineering`.
+ * Returns a copy of `self` with `scientificNotation` set to `Engineering`
  *
  * @category Modifiers
  */
@@ -475,7 +475,7 @@ export const withEngineeringScientificNotation = /*#__PURE__*/flow(/*#__PURE__*/
   scientificNotation: ScientificNotation.Engineering
 }), make);
 /**
- * Combinator that returns a copy of self with `thousandSeparator` set to `thousandSeparator`.
+ * Returns a copy of `self` with `thousandSeparator` set to `thousandSeparator`
  *
  * @category Modifiers
  */
@@ -483,13 +483,13 @@ export const withThousandSeparator = thousandSeparator => flow(MStruct.append({
   thousandSeparator
 }), make);
 /**
- * Combinator that returns a copy of self with `thousandSeparator` set to ''.
+ * Returns a copy of `self` with `thousandSeparator` set to ''
  *
  * @category Modifiers
  */
 export const withoutThousandSeparator = /*#__PURE__*/withThousandSeparator('');
 /**
- * Combinator that returns a copy of self with `fractionalSeparator` set to `fractionalSeparator`.
+ * Returns a copy of `self` with `fractionalSeparator` set to `fractionalSeparator`
  *
  * @category Modifiers
  */
@@ -497,7 +497,7 @@ export const withFractionalSeparator = fractionalSeparator => flow(MStruct.appen
   fractionalSeparator: fractionalSeparator
 }), make);
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Auto`.
+ * Returns a copy of `self` with `signDisplay` set to `Auto`
  *
  * @category Modifiers
  */
@@ -505,7 +505,7 @@ export const withSignDisplayForNegative = /*#__PURE__*/flow(/*#__PURE__*/MStruct
   signDisplay: SignDisplay.Auto
 }), make);
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Always`.
+ * Returns a copy of `self` with `signDisplay` set to `Always`
  *
  * @category Modifiers
  */
@@ -513,7 +513,7 @@ export const withSignDisplay = /*#__PURE__*/flow(/*#__PURE__*/MStruct.append({
   signDisplay: SignDisplay.Always
 }), make);
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `ExceptZero`.
+ * Returns a copy of `self` with `signDisplay` set to `ExceptZero`
  *
  * @category Modifiers
  */
@@ -521,7 +521,7 @@ export const withSignDisplayExceptZero = /*#__PURE__*/flow(/*#__PURE__*/MStruct.
   signDisplay: SignDisplay.ExceptZero
 }), make);
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Negative`.
+ * Returns a copy of `self` with `signDisplay` set to `Negative`
  *
  * @category Modifiers
  */
@@ -529,7 +529,7 @@ export const withSignDisplayForNegativeExceptZero = /*#__PURE__*/flow(/*#__PURE_
   signDisplay: SignDisplay.Negative
 }), make);
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Never`.
+ * Returns a copy of `self` with `signDisplay` set to `Never`
  *
  * @category Modifiers
  */
@@ -537,7 +537,7 @@ export const withoutSignDisplay = /*#__PURE__*/flow(/*#__PURE__*/MStruct.append(
   signDisplay: SignDisplay.Never
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Ceil`.
+ * Returns a copy of `self` with `roundingMode` set to `Ceil`
  *
  * @category Modifiers
  */
@@ -545,7 +545,7 @@ export const withCeilRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.appen
   roundingMode: CVRoundingMode.Type.Ceil
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Floor`.
+ * Returns a copy of `self` with `roundingMode` set to `Floor`
  *
  * @category Modifiers
  */
@@ -553,7 +553,7 @@ export const withFloorRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.appe
   roundingMode: CVRoundingMode.Type.Floor
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Expand`.
+ * Returns a copy of `self` with `roundingMode` set to `Expand`
  *
  * @category Modifiers
  */
@@ -561,7 +561,7 @@ export const withExpandRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.app
   roundingMode: CVRoundingMode.Type.Expand
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Trunc`.
+ * Returns a copy of `self` with `roundingMode` set to `Trunc`
  *
  * @category Modifiers
  */
@@ -569,7 +569,7 @@ export const withTruncRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.appe
   roundingMode: CVRoundingMode.Type.Trunc
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfCeil`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfCeil`
  *
  * @category Modifiers
  */
@@ -577,7 +577,7 @@ export const withHalfCeilRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.a
   roundingMode: CVRoundingMode.Type.HalfCeil
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfFloor`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfFloor`
  *
  * @category Modifiers
  */
@@ -585,7 +585,7 @@ export const withHalfFloorRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.
   roundingMode: CVRoundingMode.Type.HalfFloor
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfExpand`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfExpand`
  *
  * @category Modifiers
  */
@@ -593,7 +593,7 @@ export const withHalfExpandRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct
   roundingMode: CVRoundingMode.Type.HalfExpand
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfTrunc`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfTrunc`
  *
  * @category Modifiers
  */
@@ -601,7 +601,7 @@ export const withHalfTruncRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.
   roundingMode: CVRoundingMode.Type.HalfTrunc
 }), make);
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfEven`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfEven`
  *
  * @category Modifiers
  */
@@ -609,7 +609,7 @@ export const withHalfEvenRoundingMode = /*#__PURE__*/flow(/*#__PURE__*/MStruct.a
   roundingMode: CVRoundingMode.Type.HalfEven
 }), make);
 /**
- * Combinator that returns a copy of self with `showNullIntegerPart` set to `false`.
+ * Returns a copy of `self` with `showNullIntegerPart` set to `false`
  *
  * @category Modifiers
  */
@@ -617,7 +617,7 @@ export const withNullIntegerPartNotShowing = /*#__PURE__*/flow(/*#__PURE__*/MStr
   showNullIntegerPart: false
 }), make);
 /**
- * Combinator that returns a copy of self with `showNullIntegerPart` set to `true`.
+ * Returns a copy of `self` with `showNullIntegerPart` set to `true`
  *
  * @category Modifiers
  */
@@ -625,7 +625,7 @@ export const withNullIntegerPartShowing = /*#__PURE__*/flow(/*#__PURE__*/MStruct
   showNullIntegerPart: true
 }), make);
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, a space as thousand
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, a space as thousand
  * separator and shows at most three fractional digits. Used in countries like France,
  * French-speaking Canada, French-speaking Belgium, Denmark, Finland, Sweden...
  *
@@ -643,22 +643,22 @@ export const frenchStyleNumber = /*#__PURE__*/make({
   signDisplay: SignDisplay.Negative
 });
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, no thousand separator and
- * shows at most three fractional digits. Used in countries like France, French-speaking Canada,
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, no thousand separator
+ * and shows at most three fractional digits. Used in countries like France, French-speaking Canada,
  * French-speaking Belgium, Denmark, Finland, Sweden...
  *
  * @category Instances
  */
 export const frenchStyleUngroupedNumber = /*#__PURE__*/pipe(frenchStyleNumber, withoutThousandSeparator);
 /**
- * French-style integer NumberBase10Format instance. Used in countries like France, French-speaking
- * Canada, French-speaking Belgium, Denmark, Finland, Sweden...
+ * French-style integer `CVNumberBase10Format` instance. Used in countries like France,
+ * French-speaking Canada, French-speaking Belgium, Denmark, Finland, Sweden...
  *
  * @category Instances
  */
 export const frenchStyleInteger = /*#__PURE__*/pipe(frenchStyleNumber, /*#__PURE__*/withMaxNDecimals(0));
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, a dot as thousand
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, a dot as thousand
  * separator and shows at most three fractional digits. Used in countries like Dutch-speaking
  * Belgium, the Netherlands, Germany, Italy, Norway, Croatia, Spain...
  *
@@ -668,22 +668,22 @@ export const dutchStyleNumber = /*#__PURE__*/pipe(frenchStyleNumber, /*#__PURE__
   thousandSeparator: '.'
 }), make);
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, no thousand separator and
- * shows at most three fractional digits. Used in countries like Dutch-speaking Belgium, the
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, no thousand separator
+ * and shows at most three fractional digits. Used in countries like Dutch-speaking Belgium, the
  * Netherlands, Germany, Italy, Norway, Croatia, Spain...
  *
  * @category Instances
  */
 export const dutchStyleUngroupedNumber = /*#__PURE__*/pipe(dutchStyleNumber, withoutThousandSeparator);
 /**
- * Dutch-style integer NumberBase10Format instance. Used in countries like Dutch-speaking Belgium,
- * the Netherlands, Germany, Italy, Norway, Croatia, Spain...
+ * Dutch-style integer `CVNumberBase10Format` instance. Used in countries like Dutch-speaking
+ * Belgium, the Netherlands, Germany, Italy, Norway, Croatia, Spain...
  *
  * @category Instances
  */
 export const dutchStyleInteger = /*#__PURE__*/pipe(dutchStyleNumber, /*#__PURE__*/withMaxNDecimals(0));
 /**
- * NumberBase10Format instance that uses a dot as fractional separator, a comma as thousand
+ * `CVNumberBase10Format` instance that uses a dot as fractional separator, a comma as thousand
  * separator and shows at most three fractional digits. Used in countries like the UK, the US,
  * English-speaking Canada, Australia, Thaïland, Bosnia...
  *
@@ -694,22 +694,22 @@ export const ukStyleNumber = /*#__PURE__*/pipe(frenchStyleNumber, /*#__PURE__*/M
   thousandSeparator: ','
 }), make);
 /**
- * NumberBase10Format instance that uses a dot as fractional separator, no thousand separator and
- * shows at most three fractional digits. Used in countries like the UK, the US, English-speaking
- * Canada, Australia, Thaïland, Bosnia...
+ * `CVNumberBase10Format` instance that uses a dot as fractional separator, no thousand separator
+ * and shows at most three fractional digits. Used in countries like the UK, the US,
+ * English-speaking Canada, Australia, Thaïland, Bosnia...
  *
  * @category Instances
  */
 export const ukStyleUngroupedNumber = /*#__PURE__*/pipe(ukStyleNumber, withoutThousandSeparator);
 /**
- * Uk-style integer NumberBase10Format instance. Used in countries like the UK, the US,
+ * Uk-style integer `CVNumberBase10Format` instance. Used in countries like the UK, the US,
  * English-speaking Canada, Australia, Thaïland, Bosnia...
  *
  * @category Instances
  */
 export const ukStyleInteger = /*#__PURE__*/pipe(ukStyleNumber, /*#__PURE__*/withMaxNDecimals(0));
 /**
- * Integer NumberBase10Format instance with no thousand separator
+ * Integer `CVNumberBase10Format` instance with no thousand separator
  *
  * @category Instances
  */