@parischap/conversions 0.1.0 → 0.3.0

package/esm/PositiveInteger.js

@@ -1,6 +1,9 @@
 /**
- * This module implements a finite integer brand (Infinity, NaN or non-null fractional part
- * disallowed)
+ * This module implements a CVPositiveInteger brand, i.e. a number that represents an integer
+ * greater than or equal to 0 (Infinity, NaN disallowed). Can be used to represent an age, a
+ * 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 CVInteger from './Integer.js';
@@ -14,151 +17,163 @@ export const moduleTag = '@parischap/conversions/PositiveInteger/';
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 export const constructor = /*#__PURE__*/Brand.all(CVInteger.constructor, CVPositive.constructor);
 /**
- * Constructs a PositiveInteger from a number without any verifications
+ * Constructs a `CVPositiveInteger` from a number without any verifications
  *
  * @category Constructors
  */
 export const unsafeFromNumber = /*#__PURE__*/Brand.nominal();
 /**
- * Constructs an Option of a PositiveInteger from a number
+ * Tries to construct a `CVPositiveInteger` 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 a PositiveInteger from a number
+ * Tries to construct a `CVPositiveInteger` 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 a PositiveInteger from a number or throws
+ * Constructs a `CVPositiveInteger` from a number if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromNumberOrThrow = constructor;
 /**
- * Constructs a PositiveInteger from a BigDecimal without any checks
+ * Constructs a `CVPositiveInteger` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigDecimal = CVInteger.unsafeFromBigDecimal;
 /**
- * Constructs an Option of a PositiveInteger from a BigDecimal
+ * Tries to construct a `CVPositiveInteger` from a `BigDecimal`. Returns a `Some` if the conversion
+ * can be performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOption = /*#__PURE__*/flow(CVInteger.fromBigDecimalOption, /*#__PURE__*/Option.flatMap(CVPositive.fromNumberOption));
 /**
- * Constructs an Either of a PositiveInteger from a BigDecimal
+ * Tries to construct a `CVPositiveInteger` from a `BigDecimal`. Returns a `Right` if the conversion
+ * can be performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimal = /*#__PURE__*/flow(CVInteger.fromBigDecimal, /*#__PURE__*/Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveInteger from a BigDecimal or throws
+ * Constructs a `CVPositiveInteger` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOrThrow = /*#__PURE__*/flow(CVInteger.fromBigDecimalOrThrow, CVPositive.fromNumberOrThrow);
 /**
- * Constructs a PositiveInteger from a BigInt without any checks
+ * Constructs a `CVPositiveInteger` from a `BigInt` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigInt = CVInteger.unsafeFromBigInt;
 /**
- * Constructs an Option of a PositiveInteger from a BigInt
+ * Tries to construct a `CVPositiveInteger` from a `BigInt`. Returns a `Some` if the conversion can
+ * be performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOption = /*#__PURE__*/flow(CVInteger.fromBigIntOption, /*#__PURE__*/Option.flatMap(CVPositive.fromNumberOption));
 /**
- * Constructs an Either of a PositiveInteger from a BigInt
+ * Tries to construct a `CVPositiveInteger` from a `BigInt`. Returns a `Right` if the conversion can
+ * be performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromBigInt = /*#__PURE__*/flow(CVInteger.fromBigInt, /*#__PURE__*/Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveInteger from a BigInt or throws
+ * Constructs a `CVPositiveInteger` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOrThrow = /*#__PURE__*/flow(CVInteger.fromBigIntOrThrow, CVPositive.fromNumberOrThrow);
 /**
- * Constructs a PositiveInteger from a Real without any checks
+ * Constructs a `CVPositiveInteger` from a `CVReal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromReal = Function.identity;
 /**
- * Constructs an Option of a PositiveInteger from a Real
+ * Tries to construct a `CVPositiveInteger` from a `CVReal`. Returns a `Some` if the conversion can
+ * be performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromRealOption = /*#__PURE__*/flow(CVInteger.fromRealOption, /*#__PURE__*/Option.flatMap(CVPositive.fromNumberOption));
 /**
- * Constructs an Either of a PositiveInteger from a Real
+ * Tries to construct a `CVPositiveInteger` from a `CVReal`. Returns a `Right` if the conversion can
+ * be performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromReal = /*#__PURE__*/flow(CVInteger.fromReal, /*#__PURE__*/Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveInteger from a Real or throws
+ * Constructs a `CVPositiveInteger` from a `CVReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromRealOrThrow = /*#__PURE__*/flow(CVInteger.fromRealOrThrow, CVPositive.fromNumberOrThrow);
 /**
- * Constructs an Option of a PositiveInteger from an Integer
+ * Tries to construct a `CVPositiveInteger` from a `CVInteger`. Returns a `Some` if the conversion
+ * can be performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromIntegerOption = /*#__PURE__*/flow(CVPositive.fromNumberOption);
 /**
- * Constructs an Either of a PositiveInteger from an Integer
+ * Tries to construct a `CVPositiveInteger` from a `CVInteger`. Returns a `Right` if the conversion
+ * can be performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromInteger = CVPositive.fromNumber;
 /**
- * Constructs a PositiveInteger from an Integer or throws
+ * Constructs a `CVPositiveInteger` from a `CVInteger` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromIntegerOrThrow = /*#__PURE__*/flow(CVPositive.fromNumberOrThrow);
 /**
- * Constructs an Option of a PositiveInteger from a PositiveReal
+ * Tries to construct a `CVPositiveInteger` from a `CVPositiveReal`. Returns a `Some` if the
+ * conversion can be performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromPositiveRealOption = /*#__PURE__*/flow(CVInteger.fromRealOption);
 /**
- * Constructs an Either of a PositiveInteger from a PositiveReal
+ * Tries to construct a `CVPositiveInteger` from a `CVPositiveReal`. Returns a `Right` if the
+ * conversion can be performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromPositiveReal = CVInteger.fromReal;
 /**
- * Constructs a PositiveInteger from a PositiveReal or throws
+ * Constructs a `CVPositiveInteger` from a `CVPositiveReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromPositiveRealOrThrow = /*#__PURE__*/flow(CVInteger.fromRealOrThrow);
 /**
- * A Schema that transforms a number into a CVPositiveInteger.Type
+ * A `Schema` that transforms a number into a `CVPositiveInteger`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromNumber = /*#__PURE__*/Schema.Number.pipe(/*#__PURE__*/Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVPositiveInteger.Type
+ * A Schema that represents a `CVPositiveInteger`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromSelf = /*#__PURE__*/Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=PositiveInteger.js.map

package/esm/PositiveInteger.js.map

@@ -1 +1 @@
-{"version":3,"file":"PositiveInteger.js","names":["Brand","Either","flow","Function","Option","Schema","CVInteger","CVPositive","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","fromIntegerOption","fromInteger","fromIntegerOrThrow","fromPositiveRealOption","fromPositiveReal","fromPositiveRealOrThrow","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveInteger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;AAMA,SAAqBA,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,QAAQ,QAAQ;AAClF,OAAO,KAAKC,SAAS,MAAM,cAAc;AACzC,OAAO,KAAKC,UAAU,MAAM,wBAAwB;AAIpD;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,yCAAyC;AAElE;;;;;AAKA,OAAO,MAAMC,WAAW,gBAAGT,KAAK,CAACU,GAAG,CAACJ,SAAS,CAACG,WAAW,EAAEF,UAAU,CAACE,WAAW,CAAC;AASnF;;;;;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,GAChCb,SAAS,CAACa,oBAA6B;AAExC;;;;;AAKA,OAAO,MAAMC,oBAAoB,gBAG7BlB,IAAI,CAACI,SAAS,CAACc,oBAAoB,eAAEhB,MAAM,CAACiB,OAAO,CAACd,UAAU,CAACM,gBAAgB,CAAC,CAAU;AAE9F;;;;;AAKA,OAAO,MAAMS,cAAc,gBAGvBpB,IAAI,CAACI,SAAS,CAACgB,cAAc,eAAErB,MAAM,CAACoB,OAAO,CAACd,UAAU,CAACS,UAAU,CAAC,CAAU;AAElF;;;;;AAKA,OAAO,MAAMO,qBAAqB,gBAAuDrB,IAAI,CAC5FI,SAAS,CAACiB,qBAAqB,EAC/BhB,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMM,gBAAgB,GAC5BlB,SAAS,CAACkB,gBAAyB;AAEpC;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAuDvB,IAAI,CACvFI,SAAS,CAACmB,gBAAgB,eAC1BrB,MAAM,CAACiB,OAAO,CAACd,UAAU,CAACM,gBAAgB,CAAC,CAClC;AAEV;;;;;AAKA,OAAO,MAAMa,UAAU,gBAGnBxB,IAAI,CAACI,SAAS,CAACoB,UAAU,eAAEzB,MAAM,CAACoB,OAAO,CAACd,UAAU,CAACS,UAAU,CAAC,CAAU;AAE9E;;;;;AAKA,OAAO,MAAMW,iBAAiB,gBAAwCzB,IAAI,CACzEI,SAAS,CAACqB,iBAAiB,EAC3BpB,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMU,cAAc,GAA6CzB,QAAQ,CAAC0B,QAAiB;AAElG;;;;;AAKA,OAAO,MAAMC,cAAc,gBAA4D5B,IAAI,CAC1FI,SAAS,CAACwB,cAAc,eACxB1B,MAAM,CAACiB,OAAO,CAACd,UAAU,CAACM,gBAAgB,CAAC,CAClC;AAEV;;;;;AAKA,OAAO,MAAMkB,QAAQ,gBAGjB7B,IAAI,CAACI,SAAS,CAACyB,QAAQ,eAAE9B,MAAM,CAACoB,OAAO,CAACd,UAAU,CAACS,UAAU,CAAC,CAAU;AAE5E;;;;;AAKA,OAAO,MAAMgB,eAAe,gBAA6C9B,IAAI,CAC5EI,SAAS,CAAC0B,eAAe,EACzBzB,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMe,iBAAiB,gBAA+D/B,IAAI,CAChGK,UAAU,CAACM,gBAAgB,CAClB;AAEV;;;;;AAKA,OAAO,MAAMqB,WAAW,GAGpB3B,UAAU,CAACS,UAAmB;AAElC;;;;;AAKA,OAAO,MAAMmB,kBAAkB,gBAAgDjC,IAAI,CAClFK,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMkB,sBAAsB,gBAG/BlC,IAAI,CAACI,SAAS,CAACwB,cAAc,CAAU;AAE3C;;;;;AAKA,OAAO,MAAMO,gBAAgB,GAGzB/B,SAAS,CAACyB,QAAiB;AAE/B;;;;;AAKA,OAAO,MAAMO,uBAAuB,gBAAqDpC,IAAI,CAC5FI,SAAS,CAAC0B,eAAe,CAChB;AAEV;;;;;AAKA,OAAO,MAAMO,gBAAgB,gBAAgClC,MAAM,CAACmC,MAAM,CAACC,IAAI,cAC9EpC,MAAM,CAACqC,SAAS,CAACjC,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAMkC,cAAc,gBAAwBtC,MAAM,CAACuC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"PositiveInteger.js","names":["Brand","Either","flow","Function","Option","Schema","CVInteger","CVPositive","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","fromIntegerOption","fromInteger","fromIntegerOrThrow","fromPositiveRealOption","fromPositiveReal","fromPositiveRealOrThrow","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveInteger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;AASA,SAAqBA,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,QAAQ,QAAQ;AAClF,OAAO,KAAKC,SAAS,MAAM,cAAc;AACzC,OAAO,KAAKC,UAAU,MAAM,wBAAwB;AAIpD;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,yCAAyC;AAElE;;;;;AAKA,OAAO,MAAMC,WAAW,gBAAGT,KAAK,CAACU,GAAG,CAACJ,SAAS,CAACG,WAAW,EAAEF,UAAU,CAACE,WAAW,CAAC;AASnF;;;;;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,GAChCb,SAAS,CAACa,oBAA6B;AAExC;;;;;;AAMA,OAAO,MAAMC,oBAAoB,gBAG7BlB,IAAI,CAACI,SAAS,CAACc,oBAAoB,eAAEhB,MAAM,CAACiB,OAAO,CAACd,UAAU,CAACM,gBAAgB,CAAC,CAAU;AAE9F;;;;;;AAMA,OAAO,MAAMS,cAAc,gBAGvBpB,IAAI,CAACI,SAAS,CAACgB,cAAc,eAAErB,MAAM,CAACoB,OAAO,CAACd,UAAU,CAACS,UAAU,CAAC,CAAU;AAElF;;;;;AAKA,OAAO,MAAMO,qBAAqB,gBAAuDrB,IAAI,CAC5FI,SAAS,CAACiB,qBAAqB,EAC/BhB,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMM,gBAAgB,GAC5BlB,SAAS,CAACkB,gBAAyB;AAEpC;;;;;;AAMA,OAAO,MAAMC,gBAAgB,gBAAuDvB,IAAI,CACvFI,SAAS,CAACmB,gBAAgB,eAC1BrB,MAAM,CAACiB,OAAO,CAACd,UAAU,CAACM,gBAAgB,CAAC,CAClC;AAEV;;;;;;AAMA,OAAO,MAAMa,UAAU,gBAGnBxB,IAAI,CAACI,SAAS,CAACoB,UAAU,eAAEzB,MAAM,CAACoB,OAAO,CAACd,UAAU,CAACS,UAAU,CAAC,CAAU;AAE9E;;;;;AAKA,OAAO,MAAMW,iBAAiB,gBAAwCzB,IAAI,CACzEI,SAAS,CAACqB,iBAAiB,EAC3BpB,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMU,cAAc,GAA6CzB,QAAQ,CAAC0B,QAAiB;AAElG;;;;;;AAMA,OAAO,MAAMC,cAAc,gBAA4D5B,IAAI,CAC1FI,SAAS,CAACwB,cAAc,eACxB1B,MAAM,CAACiB,OAAO,CAACd,UAAU,CAACM,gBAAgB,CAAC,CAClC;AAEV;;;;;;AAMA,OAAO,MAAMkB,QAAQ,gBAGjB7B,IAAI,CAACI,SAAS,CAACyB,QAAQ,eAAE9B,MAAM,CAACoB,OAAO,CAACd,UAAU,CAACS,UAAU,CAAC,CAAU;AAE5E;;;;;AAKA,OAAO,MAAMgB,eAAe,gBAA6C9B,IAAI,CAC5EI,SAAS,CAAC0B,eAAe,EACzBzB,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;;AAMA,OAAO,MAAMe,iBAAiB,gBAA+D/B,IAAI,CAChGK,UAAU,CAACM,gBAAgB,CAClB;AAEV;;;;;;AAMA,OAAO,MAAMqB,WAAW,GAGpB3B,UAAU,CAACS,UAAmB;AAElC;;;;;AAKA,OAAO,MAAMmB,kBAAkB,gBAAgDjC,IAAI,CAClFK,UAAU,CAACW,iBAAiB,CACnB;AAEV;;;;;;AAMA,OAAO,MAAMkB,sBAAsB,gBAG/BlC,IAAI,CAACI,SAAS,CAACwB,cAAc,CAAU;AAE3C;;;;;;AAMA,OAAO,MAAMO,gBAAgB,GAGzB/B,SAAS,CAACyB,QAAiB;AAE/B;;;;;AAKA,OAAO,MAAMO,uBAAuB,gBAAqDpC,IAAI,CAC5FI,SAAS,CAAC0B,eAAe,CAChB;AAEV;;;;;AAKA,OAAO,MAAMO,gBAAgB,gBAAgClC,MAAM,CAACmC,MAAM,CAACC,IAAI,cAC9EpC,MAAM,CAACqC,SAAS,CAACjC,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAMkC,cAAc,gBAAwBtC,MAAM,CAACuC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}

package/esm/PositiveReal.js

@@ -1,6 +1,8 @@
 /**
- * This module implements a positive finite number brand (NaN, Infinity and negative numbers
- * disallowed). Useful for a price, a physical quantity...
+ * This module implements a CVPositiveReal brand, i.e. a number greater than or equal to 0
+ * (Infinity, NaN disallowed). Can be used to represent a price, a speed,... See the `Effect`
+ * documentation about Branding (https://effect.website/docs/code-style/branded-types/) if you are
+ * not familiar with this concept.
  */
 import { MNumber } from '@parischap/effect-lib';
 import { Brand, Either, flow, Function, Option, Schema } from 'effect';
@@ -15,121 +17,129 @@ export const moduleTag = '@parischap/conversions/PositiveReal/';
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 export const constructor = /*#__PURE__*/Brand.all(CVReal.constructor, CVPositive.constructor);
 /**
- * Constructs a PositiveReal from a number without any verifications
+ * Constructs a `CVPositiveReal` from a number without any verifications
  *
  * @category Constructors
  */
 export const unsafeFromNumber = /*#__PURE__*/Brand.nominal();
 /**
- * Constructs an Option of a PositiveReal from a number
+ * Tries to construct a `CVPositiveReal` 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 a PositiveReal from a number
+ * Tries to construct a `CVPositiveReal` 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 a PositiveReal from a number or throws
+ * Constructs a `CVPositiveReal` from a number if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromNumberOrThrow = constructor;
 /**
- * Constructs a PositiveReal from a BigDecimal without any checks
+ * Constructs a `CVPositiveReal` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigDecimal = MNumber.unsafeFromBigDecimal;
 /**
- * Constructs an Option of a PositiveReal from a BigDecimal
+ * Tries to construct a `CVPositiveReal` 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(CVPositive.fromNumberOption));
 /**
- * Constructs an Either of a PositiveReal from a BigDecimal
+ * Tries to construct a `CVPositiveReal` 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(CVPositive.fromNumber));
 /**
- * Constructs a PositiveReal from a BigDecimal or throws
+ * Constructs a `CVPositiveReal` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOrThrow = /*#__PURE__*/flow(CVReal.fromBigDecimalOrThrow, CVPositive.fromNumberOrThrow);
 /**
- * Constructs a PositiveReal from a BigInt without any checks
+ * Constructs a `CVPositiveReal` from a `BigInt` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigInt = MNumber.unsafeFromBigInt;
 /**
- * Constructs an Option of a PositiveReal from a BigInt
+ * Tries to construct a `CVPositiveReal` from a `BigInt`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOption = /*#__PURE__*/flow(CVReal.fromBigIntOption, /*#__PURE__*/Option.flatMap(CVPositive.fromNumberOption));
 /**
- * Constructs an Either of a PositiveReal from a BigInt
+ * Tries to construct a `CVPositiveReal` 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(CVPositive.fromNumber));
 /**
- * Constructs a PositiveReal from a BigInt or throws
+ * Constructs a `CVPositiveReal` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOrThrow = /*#__PURE__*/flow(CVReal.fromBigIntOrThrow, CVPositive.fromNumberOrThrow);
 /**
- * Constructs a PositiveReal from a Real without any checks
+ * Constructs a `CVPositiveReal` from a `CVReal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromReal = Function.identity;
 /**
- * Constructs an Option of a PositiveReal from a Real
+ * Tries to construct a `CVPositiveReal` from a `CVReal`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromRealOption = CVPositive.fromNumberOption;
 /**
- * Constructs an Either of a PositiveReal from a Real
+ * Tries to construct a `CVPositiveReal` from a `CVReal`. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromReal = CVPositive.fromNumber;
 /**
- * Constructs a PositiveReal from a Real or throws
+ * Constructs a `CVPositiveReal` from a `CVReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromRealOrThrow = CVPositive.fromNumberOrThrow;
 /**
- * Constructs a PositiveReal from a PositiveInteger
+ * Constructs a `CVPositiveReal` from a `CVPositiveInteger`
  *
  * @category Constructors
  */
 export const fromPositiveInteger = Function.identity;
 /**
- * A Schema that transforms a number into a CVPositiveReal.Type
+ * A `Schema` that transforms a number into a `CVPositiveReal`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromNumber = /*#__PURE__*/Schema.Number.pipe(/*#__PURE__*/Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVPositiveReal.Type
+ * A `Schema` that represents a `CVPositiveReal`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromSelf = /*#__PURE__*/Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=PositiveReal.js.map

package/esm/PositiveReal.js.map

@@ -1 +1 @@
-{"version":3,"file":"PositiveReal.js","names":["MNumber","Brand","Either","flow","Function","Option","Schema","CVPositive","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","fromPositiveInteger","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveReal.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;AAKA,SAASA,OAAO,QAAgB,uBAAuB;AACvD,SAAqBC,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,QAAQ,QAAQ;AAClF,OAAO,KAAKC,UAAU,MAAM,wBAAwB;AAEpD,OAAO,KAAKC,MAAM,MAAM,WAAW;AAEnC;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,sCAAsC;AAE/D;;;;;AAKA,OAAO,MAAMC,WAAW,gBAAGT,KAAK,CAACU,GAAG,CAACH,MAAM,CAACE,WAAW,EAAEH,UAAU,CAACG,WAAW,CAAC;AAShF;;;;;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,GAChCpB,OAAO,CAACoB,oBAA6B;AAEtC;;;;;AAKA,OAAO,MAAMC,oBAAoB,gBAG7BlB,IAAI,CAACK,MAAM,CAACa,oBAAoB,eAAEhB,MAAM,CAACiB,OAAO,CAACf,UAAU,CAACO,gBAAgB,CAAC,CAAU;AAE3F;;;;;AAKA,OAAO,MAAMS,cAAc,gBAGvBpB,IAAI,CAACK,MAAM,CAACe,cAAc,eAAErB,MAAM,CAACoB,OAAO,CAACf,UAAU,CAACU,UAAU,CAAC,CAAU;AAE/E;;;;;AAKA,OAAO,MAAMO,qBAAqB,gBAAuDrB,IAAI,CAC5FK,MAAM,CAACgB,qBAAqB,EAC5BjB,UAAU,CAACY,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMM,gBAAgB,GAC5BzB,OAAO,CAACyB,gBAAyB;AAElC;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAuDvB,IAAI,CACvFK,MAAM,CAACkB,gBAAgB,eACvBrB,MAAM,CAACiB,OAAO,CAACf,UAAU,CAACO,gBAAgB,CAAC,CAClC;AAEV;;;;;AAKA,OAAO,MAAMa,UAAU,gBAGnBxB,IAAI,CAACK,MAAM,CAACmB,UAAU,eAAEzB,MAAM,CAACoB,OAAO,CAACf,UAAU,CAACU,UAAU,CAAC,CAAU;AAE3E;;;;;AAKA,OAAO,MAAMW,iBAAiB,gBAAwCzB,IAAI,CACzEK,MAAM,CAACoB,iBAAiB,EACxBrB,UAAU,CAACY,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMU,cAAc,GAA6CzB,QAAQ,CAAC0B,QAAiB;AAElG;;;;;AAKA,OAAO,MAAMC,cAAc,GAGvBxB,UAAU,CAACO,gBAAyB;AAExC;;;;;AAKA,OAAO,MAAMkB,QAAQ,GAGjBzB,UAAU,CAACU,UAAmB;AAElC;;;;;AAKA,OAAO,MAAMgB,eAAe,GAC3B1B,UAAU,CAACY,iBAA0B;AAEtC;;;;;AAKA,OAAO,MAAMe,mBAAmB,GAC/B9B,QAAQ,CAAC0B,QAAiB;AAE3B;;;;;AAKA,OAAO,MAAMK,gBAAgB,gBAAgC7B,MAAM,CAAC8B,MAAM,CAACC,IAAI,cAC9E/B,MAAM,CAACgC,SAAS,CAAC5B,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAM6B,cAAc,gBAAwBjC,MAAM,CAACkC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"PositiveReal.js","names":["MNumber","Brand","Either","flow","Function","Option","Schema","CVPositive","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","fromPositiveInteger","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveReal.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;AAOA,SAASA,OAAO,QAAgB,uBAAuB;AACvD,SAAqBC,KAAK,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,QAAQ,QAAQ;AAClF,OAAO,KAAKC,UAAU,MAAM,wBAAwB;AAEpD,OAAO,KAAKC,MAAM,MAAM,WAAW;AAEnC;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,sCAAsC;AAE/D;;;;;AAKA,OAAO,MAAMC,WAAW,gBAAGT,KAAK,CAACU,GAAG,CAACH,MAAM,CAACE,WAAW,EAAEH,UAAU,CAACG,WAAW,CAAC;AAShF;;;;;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,GAChCpB,OAAO,CAACoB,oBAA6B;AAEtC;;;;;;AAMA,OAAO,MAAMC,oBAAoB,gBAG7BlB,IAAI,CAACK,MAAM,CAACa,oBAAoB,eAAEhB,MAAM,CAACiB,OAAO,CAACf,UAAU,CAACO,gBAAgB,CAAC,CAAU;AAE3F;;;;;;AAMA,OAAO,MAAMS,cAAc,gBAGvBpB,IAAI,CAACK,MAAM,CAACe,cAAc,eAAErB,MAAM,CAACoB,OAAO,CAACf,UAAU,CAACU,UAAU,CAAC,CAAU;AAE/E;;;;;AAKA,OAAO,MAAMO,qBAAqB,gBAAuDrB,IAAI,CAC5FK,MAAM,CAACgB,qBAAqB,EAC5BjB,UAAU,CAACY,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMM,gBAAgB,GAC5BzB,OAAO,CAACyB,gBAAyB;AAElC;;;;;;AAMA,OAAO,MAAMC,gBAAgB,gBAAuDvB,IAAI,CACvFK,MAAM,CAACkB,gBAAgB,eACvBrB,MAAM,CAACiB,OAAO,CAACf,UAAU,CAACO,gBAAgB,CAAC,CAClC;AAEV;;;;;;AAMA,OAAO,MAAMa,UAAU,gBAGnBxB,IAAI,CAACK,MAAM,CAACmB,UAAU,eAAEzB,MAAM,CAACoB,OAAO,CAACf,UAAU,CAACU,UAAU,CAAC,CAAU;AAE3E;;;;;AAKA,OAAO,MAAMW,iBAAiB,gBAAwCzB,IAAI,CACzEK,MAAM,CAACoB,iBAAiB,EACxBrB,UAAU,CAACY,iBAAiB,CACnB;AAEV;;;;;AAKA,OAAO,MAAMU,cAAc,GAA6CzB,QAAQ,CAAC0B,QAAiB;AAElG;;;;;;AAMA,OAAO,MAAMC,cAAc,GAGvBxB,UAAU,CAACO,gBAAyB;AAExC;;;;;;AAMA,OAAO,MAAMkB,QAAQ,GAGjBzB,UAAU,CAACU,UAAmB;AAElC;;;;;AAKA,OAAO,MAAMgB,eAAe,GAC3B1B,UAAU,CAACY,iBAA0B;AAEtC;;;;;AAKA,OAAO,MAAMe,mBAAmB,GAC/B9B,QAAQ,CAAC0B,QAAiB;AAE3B;;;;;AAKA,OAAO,MAAMK,gBAAgB,gBAAgC7B,MAAM,CAAC8B,MAAM,CAACC,IAAI,cAC9E/B,MAAM,CAACgC,SAAS,CAAC5B,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAM6B,cAAc,gBAAwBjC,MAAM,CAACkC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}

package/esm/Real.js

@@ -1,4 +1,9 @@
-/** This module implements a finite number brand (Infinity or Nan disallowed) */
+/**
+ * This module implements a CVReal brand, i.e. a number that disallows Infinity and NaN. Can be used
+ * to represent a temperature, a height from sea-level,... See the `Effect` documentation about
+ * Branding (https://effect.website/docs/code-style/branded-types/) if you are not familiar with
+ * this concept.
+ */
 import { MNumber, MString } from '@parischap/effect-lib';
 import { Brand, flow, Schema } from 'effect';
 /**
@@ -16,91 +21,97 @@ export const TypeId = /*#__PURE__*/Symbol.for(moduleTag);
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 export const constructor = /*#__PURE__*/Brand.refined(MNumber.isFinite, /*#__PURE__*/flow(/*#__PURE__*/MString.fromNumber(10), /*#__PURE__*/MString.prepend("'"), /*#__PURE__*/MString.append("' does not represent a finite number"), Brand.error));
 /**
- * Constructs a Real from a number without any verifications
+ * Constructs a `CVReal` from a number without any verifications
  *
  * @category Constructors
  */
 export const unsafeFromNumber = /*#__PURE__*/Brand.nominal();
 /**
- * Constructs an Option of a Real from a number
+ * Tries to construct a `CVReal` 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 a Real from a number
+ * Tries to construct a `CVReal` 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 a Real from a number or throws
+ * Constructs a `CVReal` from a number if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromNumberOrThrow = constructor;
 /**
- * Constructs a Real from a BigDecimal without any checks
+ * Constructs a `CVReal` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigDecimal = MNumber.unsafeFromBigDecimal;
 /**
- * Constructs an Option of a Real from a BigDecimal.
+ * Tries to construct a `CVReal` from a `BigDecimal`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOption = MNumber.fromBigDecimalOption;
 /**
- * Constructs an Either of a Real from a BigDecimal.
+ * Tries to construct a `CVReal` from a `BigDecimal`. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimal = MNumber.fromBigDecimal;
 /**
- * Constructs a Real from a BigDecimal or throws
+ * Constructs a `CVReal` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigDecimalOrThrow = MNumber.fromBigDecimalOrThrow;
 /**
- * Constructs a Real from a BigInt without any checks
+ * Constructs a `CVReal` from a `BigInt` without any checks
  *
  * @category Constructors
  */
 export const unsafeFromBigInt = MNumber.unsafeFromBigInt;
 /**
- * Constructs an Option of a Real from a BigInt.
+ * Tries to construct a `CVReal` from a `BigInt`. Returns a `Some` if the conversion can be
+ * performed, a `None` otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOption = MNumber.fromBigIntOption;
 /**
- * Constructs an Either of a Real from a BigInt.
+ * Tries to construct a `CVReal` from a `BigInt`. Returns a `Right` if the conversion can be
+ * performed, a `Left` otherwise
  *
  * @category Constructors
  */
 export const fromBigInt = MNumber.fromBigInt;
 /**
- * Constructs a Real from a BigInt or throws
+ * Constructs a `CVReal` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export const fromBigIntOrThrow = MNumber.fromBigIntOrThrow;
 /**
- * A Schema that transforms a number into an CVReal.Type
+ * A `Schema` that transforms a number into a `CVReal`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromNumber = /*#__PURE__*/Schema.Number.pipe(/*#__PURE__*/Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVReal.Type
+ * A `Schema` that represents a `CVReal`
  *
- * @internal
+ * @ignore
  */
 export const SchemaFromSelf = /*#__PURE__*/Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=Real.js.map

package/esm/Real.js.map

@@ -1 +1 @@
-{"version":3,"file":"Real.js","names":["MNumber","MString","Brand","flow","Schema","moduleTag","TypeId","Symbol","for","constructor","refined","isFinite","fromNumber","prepend","append","error","unsafeFromNumber","nominal","fromNumberOption","option","bind","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","fromBigDecimal","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Real.ts"],"sourcesContent":[null],"mappings":"AAAA;AAEA,SAASA,OAAO,EAAEC,OAAO,QAAgB,uBAAuB;AAChE,SAAqBC,KAAK,EAAUC,IAAI,EAAUC,MAAM,QAAQ,QAAQ;AAExE;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,8BAA8B;AAEvD;;;;;AAKA,OAAO,MAAMC,MAAM,gBAAkBC,MAAM,CAACC,GAAG,CAACH,SAAS,CAAY;AAUrE;;;;;AAKA,OAAO,MAAMI,WAAW,gBAAGP,KAAK,CAACQ,OAAO,CACvCV,OAAO,CAACW,QAAQ,eAChBR,IAAI,cACHF,OAAO,CAACW,UAAU,CAAC,EAAE,CAAC,eACtBX,OAAO,CAACY,OAAO,CAAC,GAAG,CAAC,eACpBZ,OAAO,CAACa,MAAM,CAAC,sCAAsC,CAAC,EACtDZ,KAAK,CAACa,KAAK,CACX,CACD;AAED;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAGd,KAAK,CAACe,OAAO,EAAQ;AAErD;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAGzBT,WAAW,CAACU,MAAM,CAACC,IAAI,CAACX,WAAW,CAAC;AAExC;;;;;AAKA,OAAO,MAAMG,UAAU,gBAGnBH,WAAW,CAACY,MAAM,CAACD,IAAI,CAACX,WAAW,CAAC;AAExC;;;;;AAKA,OAAO,MAAMa,iBAAiB,GAAwCb,WAAW;AAEjF;;;;;AAKA,OAAO,MAAMc,oBAAoB,GAChCvB,OAAO,CAACuB,oBAA6B;AAEtC;;;;;AAKA,OAAO,MAAMC,oBAAoB,GAG7BxB,OAAO,CAACwB,oBAA6B;AAEzC;;;;;AAKA,OAAO,MAAMC,cAAc,GAGvBzB,OAAO,CAACyB,cAAuB;AAEnC;;;;;AAKA,OAAO,MAAMC,qBAAqB,GACjC1B,OAAO,CAAC0B,qBAA8B;AAEvC;;;;;AAKA,OAAO,MAAMC,gBAAgB,GAC5B3B,OAAO,CAAC2B,gBAAyB;AAElC;;;;;AAKA,OAAO,MAAMC,gBAAgB,GAGzB5B,OAAO,CAAC4B,gBAAyB;AAErC;;;;;AAKA,OAAO,MAAMC,UAAU,GAGnB7B,OAAO,CAAC6B,UAAmB;AAE/B;;;;;AAKA,OAAO,MAAMC,iBAAiB,GAC7B9B,OAAO,CAAC8B,iBAA0B;AAEnC;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAgC3B,MAAM,CAAC4B,MAAM,CAACC,IAAI,cAC9E7B,MAAM,CAAC8B,SAAS,CAACzB,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAM0B,cAAc,gBAAwB/B,MAAM,CAACgC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"Real.js","names":["MNumber","MString","Brand","flow","Schema","moduleTag","TypeId","Symbol","for","constructor","refined","isFinite","fromNumber","prepend","append","error","unsafeFromNumber","nominal","fromNumberOption","option","bind","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","fromBigDecimal","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","SchemaFromNumber","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Real.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;AAOA,SAASA,OAAO,EAAEC,OAAO,QAAgB,uBAAuB;AAChE,SAAqBC,KAAK,EAAUC,IAAI,EAAUC,MAAM,QAAQ,QAAQ;AAExE;;;;;AAKA,OAAO,MAAMC,SAAS,GAAG,8BAA8B;AAEvD;;;;;AAKA,OAAO,MAAMC,MAAM,gBAAkBC,MAAM,CAACC,GAAG,CAACH,SAAS,CAAY;AAUrE;;;;;AAKA,OAAO,MAAMI,WAAW,gBAAGP,KAAK,CAACQ,OAAO,CACvCV,OAAO,CAACW,QAAQ,eAChBR,IAAI,cACHF,OAAO,CAACW,UAAU,CAAC,EAAE,CAAC,eACtBX,OAAO,CAACY,OAAO,CAAC,GAAG,CAAC,eACpBZ,OAAO,CAACa,MAAM,CAAC,sCAAsC,CAAC,EACtDZ,KAAK,CAACa,KAAK,CACX,CACD;AAED;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAGd,KAAK,CAACe,OAAO,EAAQ;AAErD;;;;;;AAMA,OAAO,MAAMC,gBAAgB,gBAGzBT,WAAW,CAACU,MAAM,CAACC,IAAI,CAACX,WAAW,CAAC;AAExC;;;;;;AAMA,OAAO,MAAMG,UAAU,gBAGnBH,WAAW,CAACY,MAAM,CAACD,IAAI,CAACX,WAAW,CAAC;AAExC;;;;;AAKA,OAAO,MAAMa,iBAAiB,GAAwCb,WAAW;AAEjF;;;;;AAKA,OAAO,MAAMc,oBAAoB,GAChCvB,OAAO,CAACuB,oBAA6B;AAEtC;;;;;;AAMA,OAAO,MAAMC,oBAAoB,GAG7BxB,OAAO,CAACwB,oBAA6B;AAEzC;;;;;;AAMA,OAAO,MAAMC,cAAc,GAGvBzB,OAAO,CAACyB,cAAuB;AAEnC;;;;;AAKA,OAAO,MAAMC,qBAAqB,GACjC1B,OAAO,CAAC0B,qBAA8B;AAEvC;;;;;AAKA,OAAO,MAAMC,gBAAgB,GAC5B3B,OAAO,CAAC2B,gBAAyB;AAElC;;;;;;AAMA,OAAO,MAAMC,gBAAgB,GAGzB5B,OAAO,CAAC4B,gBAAyB;AAErC;;;;;;AAMA,OAAO,MAAMC,UAAU,GAGnB7B,OAAO,CAAC6B,UAAmB;AAE/B;;;;;AAKA,OAAO,MAAMC,iBAAiB,GAC7B9B,OAAO,CAAC8B,iBAA0B;AAEnC;;;;;AAKA,OAAO,MAAMC,gBAAgB,gBAAgC3B,MAAM,CAAC4B,MAAM,CAACC,IAAI,cAC9E7B,MAAM,CAAC8B,SAAS,CAACzB,WAAW,CAAC,CAC7B;AAED;;;;;AAKA,OAAO,MAAM0B,cAAc,gBAAwB/B,MAAM,CAACgC,UAAU,CAACL,gBAAgB,CAAC","ignoreList":[]}

package/esm/RoundingMode.js

@@ -1,8 +1,11 @@
-/** This module defines possible rounding modes (see Intl.NumberFormat) */
+/**
+ * This module defines the list of available rounding modes (see Intl.NumberFormat) that can be used
+ * by a `CVRoundingOption` (see RoundingOption.ts)
+ */
 import { MMatch } from '@parischap/effect-lib';
 import { flow, Function, Struct } from 'effect';
 /**
- * Possible rounding modes
+ * Type that represents the possible rounding modes
  *
  * @category Models
  */
@@ -54,7 +57,7 @@ export var Type;
  *
  * @category Destructors
  */
-export const toName = /*#__PURE__*/flow(MMatch.make, /*#__PURE__*/flow(/*#__PURE__*/MMatch.whenIs(Type.Ceil, /*#__PURE__*/Function.constant('Ceil')), /*#__PURE__*/MMatch.whenIs(Type.Floor, /*#__PURE__*/Function.constant('Floor')), /*#__PURE__*/MMatch.whenIs(Type.Expand, /*#__PURE__*/Function.constant('Expand')), /*#__PURE__*/MMatch.whenIs(Type.Trunc, /*#__PURE__*/Function.constant('Trunc')), /*#__PURE__*/MMatch.whenIs(Type.HalfCeil, /*#__PURE__*/Function.constant('HalfCeil')), /*#__PURE__*/MMatch.whenIs(Type.HalfFloor, /*#__PURE__*/Function.constant('HalfFloor')), /*#__PURE__*/MMatch.whenIs(Type.HalfExpand, /*#__PURE__*/Function.constant('HalfExpand')), /*#__PURE__*/MMatch.whenIs(Type.HalfTrunc, /*#__PURE__*/Function.constant('HalfTrunc')), /*#__PURE__*/MMatch.whenIs(Type.HalfEven, /*#__PURE__*/Function.constant('HalfEven'))), MMatch.exhaustive);
+export const getName = /*#__PURE__*/flow(MMatch.make, /*#__PURE__*/flow(/*#__PURE__*/MMatch.whenIs(Type.Ceil, /*#__PURE__*/Function.constant('Ceil')), /*#__PURE__*/MMatch.whenIs(Type.Floor, /*#__PURE__*/Function.constant('Floor')), /*#__PURE__*/MMatch.whenIs(Type.Expand, /*#__PURE__*/Function.constant('Expand')), /*#__PURE__*/MMatch.whenIs(Type.Trunc, /*#__PURE__*/Function.constant('Trunc')), /*#__PURE__*/MMatch.whenIs(Type.HalfCeil, /*#__PURE__*/Function.constant('HalfCeil')), /*#__PURE__*/MMatch.whenIs(Type.HalfFloor, /*#__PURE__*/Function.constant('HalfFloor')), /*#__PURE__*/MMatch.whenIs(Type.HalfExpand, /*#__PURE__*/Function.constant('HalfExpand')), /*#__PURE__*/MMatch.whenIs(Type.HalfTrunc, /*#__PURE__*/Function.constant('HalfTrunc')), /*#__PURE__*/MMatch.whenIs(Type.HalfEven, /*#__PURE__*/Function.constant('HalfEven'))), MMatch.exhaustive);
 /**
  * Builds a `Correcter` implementing `self`
  *

package/esm/RoundingMode.js.map

@@ -1 +1 @@
-{"version":3,"file":"RoundingMode.js","names":["MMatch","flow","Function","Struct","Type","toName","make","whenIs","Ceil","constant","Floor","Expand","Trunc","HalfCeil","HalfFloor","HalfExpand","HalfTrunc","HalfEven","exhaustive","toCorrecter","firstFollowingDigit","get","Math","sign","isEven"],"sources":["../../esm/RoundingMode.ts"],"sourcesContent":[null],"mappings":"AAAA;AAEA,SAASA,MAAM,QAAgB,uBAAuB;AACtD,SAASC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,QAAQ,QAAQ;AAE/C;;;;;AAKA,WAAYC,IAyCX;AAzCD,WAAYA,IAAI;EACf;EACAA,IAAA,CAAAA,IAAA,sBAAQ;EACR;EACAA,IAAA,CAAAA,IAAA,wBAAS;EACT;;;;EAIAA,IAAA,CAAAA,IAAA,0BAAU;EACV;;;;EAIAA,IAAA,CAAAA,IAAA,wBAAS;EACT;;;;EAIAA,IAAA,CAAAA,IAAA,8BAAY;EACZ;;;;EAIAA,IAAA,CAAAA,IAAA,gCAAa;EACb;;;;EAIAA,IAAA,CAAAA,IAAA,kCAAc;EACd;;;;EAIAA,IAAA,CAAAA,IAAA,gCAAa;EACb;;;;;EAKAA,IAAA,CAAAA,IAAA,8BAAY;AACb,CAAC,EAzCWA,IAAI,KAAJA,IAAI;AA2ChB;;;;;AAKA,OAAO,MAAMC,MAAM,gBAAwCJ,IAAI,CAC9DD,MAAM,CAACM,IAAI,eACXL,IAAI,cACHD,MAAM,CAACO,MAAM,CAACH,IAAI,CAACI,IAAI,eAAEN,QAAQ,CAACO,QAAQ,CAAC,MAAM,CAAC,CAAC,eACnDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACM,KAAK,eAAER,QAAQ,CAACO,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACO,MAAM,eAAET,QAAQ,CAACO,QAAQ,CAAC,QAAQ,CAAC,CAAC,eACvDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACQ,KAAK,eAAEV,QAAQ,CAACO,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACS,QAAQ,eAAEX,QAAQ,CAACO,QAAQ,CAAC,UAAU,CAAC,CAAC,eAC3DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACU,SAAS,eAAEZ,QAAQ,CAACO,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACW,UAAU,eAAEb,QAAQ,CAACO,QAAQ,CAAC,YAAY,CAAC,CAAC,eAC/DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACY,SAAS,eAAEd,QAAQ,CAACO,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACa,QAAQ,eAAEf,QAAQ,CAACO,QAAQ,CAAC,UAAU,CAAC,CAAC,CAC3D,EACDT,MAAM,CAACkB,UAAU,CACjB;AAgBD;;;;;AAKA,OAAO,MAAMC,WAAW,gBAA2ClB,IAAI,CACtED,MAAM,CAACM,IAAI,eACXL,IAAI,cACHD,MAAM,CAACO,MAAM,CACZH,IAAI,CAACI,IAAI,EACT,MACC,CAAC;EAAEY;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CACjC,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACM,KAAK,EACV,MACC,CAAC;EAAEU;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAClC,eACDpB,MAAM,CAACO,MAAM,CAACH,IAAI,CAACO,MAAM,EAAE,MAAiBV,IAAI,CAACE,MAAM,CAACkB,GAAG,CAAC,qBAAqB,CAAC,EAAEC,IAAI,CAACC,IAAI,CAAC,CAAC,eAC/FvB,MAAM,CAACO,MAAM,CAACH,IAAI,CAACQ,KAAK,EAAE,MAAiBV,QAAQ,CAACO,QAAQ,CAAC,CAAC,CAAC,CAAC,eAChET,MAAM,CAACO,MAAM,CACZH,IAAI,CAACS,QAAQ,EACb,MACC,CAAC;EAAEO;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACU,SAAS,EACd,MACC,CAAC;EAAEM;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACW,UAAU,EACf,MACC,CAAC;EAAEK;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACY,SAAS,EACd,MACC,CAAC;EAAEI;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACa,QAAQ,EACb,MACC,CAAC;EAAEG,mBAAmB;EAAEI;AAAM,CAAE,KAC/BJ,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7BA,mBAAmB,KAAK,CAAC,GAC1BI,MAAM,GAAG,CAAC,GACR,CAAC,GACFJ,mBAAmB,KAAK,CAAC,CAAC,GAC3BI,MAAM,GAAG,CAAC,GACR,CAAC,CAAC,GACH,CAAC,CACL,CACD,EACDxB,MAAM,CAACkB,UAAU,CACjB","ignoreList":[]}
+{"version":3,"file":"RoundingMode.js","names":["MMatch","flow","Function","Struct","Type","getName","make","whenIs","Ceil","constant","Floor","Expand","Trunc","HalfCeil","HalfFloor","HalfExpand","HalfTrunc","HalfEven","exhaustive","toCorrecter","firstFollowingDigit","get","Math","sign","isEven"],"sources":["../../esm/RoundingMode.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;AAKA,SAASA,MAAM,QAAgB,uBAAuB;AACtD,SAASC,IAAI,EAAEC,QAAQ,EAAEC,MAAM,QAAQ,QAAQ;AAE/C;;;;;AAKA,WAAYC,IAyCX;AAzCD,WAAYA,IAAI;EACf;EACAA,IAAA,CAAAA,IAAA,sBAAQ;EACR;EACAA,IAAA,CAAAA,IAAA,wBAAS;EACT;;;;EAIAA,IAAA,CAAAA,IAAA,0BAAU;EACV;;;;EAIAA,IAAA,CAAAA,IAAA,wBAAS;EACT;;;;EAIAA,IAAA,CAAAA,IAAA,8BAAY;EACZ;;;;EAIAA,IAAA,CAAAA,IAAA,gCAAa;EACb;;;;EAIAA,IAAA,CAAAA,IAAA,kCAAc;EACd;;;;EAIAA,IAAA,CAAAA,IAAA,gCAAa;EACb;;;;;EAKAA,IAAA,CAAAA,IAAA,8BAAY;AACb,CAAC,EAzCWA,IAAI,KAAJA,IAAI;AA2ChB;;;;;AAKA,OAAO,MAAMC,OAAO,gBAAwCJ,IAAI,CAC/DD,MAAM,CAACM,IAAI,eACXL,IAAI,cACHD,MAAM,CAACO,MAAM,CAACH,IAAI,CAACI,IAAI,eAAEN,QAAQ,CAACO,QAAQ,CAAC,MAAM,CAAC,CAAC,eACnDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACM,KAAK,eAAER,QAAQ,CAACO,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACO,MAAM,eAAET,QAAQ,CAACO,QAAQ,CAAC,QAAQ,CAAC,CAAC,eACvDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACQ,KAAK,eAAEV,QAAQ,CAACO,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACS,QAAQ,eAAEX,QAAQ,CAACO,QAAQ,CAAC,UAAU,CAAC,CAAC,eAC3DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACU,SAAS,eAAEZ,QAAQ,CAACO,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACW,UAAU,eAAEb,QAAQ,CAACO,QAAQ,CAAC,YAAY,CAAC,CAAC,eAC/DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACY,SAAS,eAAEd,QAAQ,CAACO,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DT,MAAM,CAACO,MAAM,CAACH,IAAI,CAACa,QAAQ,eAAEf,QAAQ,CAACO,QAAQ,CAAC,UAAU,CAAC,CAAC,CAC3D,EACDT,MAAM,CAACkB,UAAU,CACjB;AAgBD;;;;;AAKA,OAAO,MAAMC,WAAW,gBAA2ClB,IAAI,CACtED,MAAM,CAACM,IAAI,eACXL,IAAI,cACHD,MAAM,CAACO,MAAM,CACZH,IAAI,CAACI,IAAI,EACT,MACC,CAAC;EAAEY;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CACjC,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACM,KAAK,EACV,MACC,CAAC;EAAEU;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAClC,eACDpB,MAAM,CAACO,MAAM,CAACH,IAAI,CAACO,MAAM,EAAE,MAAiBV,IAAI,CAACE,MAAM,CAACkB,GAAG,CAAC,qBAAqB,CAAC,EAAEC,IAAI,CAACC,IAAI,CAAC,CAAC,eAC/FvB,MAAM,CAACO,MAAM,CAACH,IAAI,CAACQ,KAAK,EAAE,MAAiBV,QAAQ,CAACO,QAAQ,CAAC,CAAC,CAAC,CAAC,eAChET,MAAM,CAACO,MAAM,CACZH,IAAI,CAACS,QAAQ,EACb,MACC,CAAC;EAAEO;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACU,SAAS,EACd,MACC,CAAC;EAAEM;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACW,UAAU,EACf,MACC,CAAC;EAAEK;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACY,SAAS,EACd,MACC,CAAC;EAAEI;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDpB,MAAM,CAACO,MAAM,CACZH,IAAI,CAACa,QAAQ,EACb,MACC,CAAC;EAAEG,mBAAmB;EAAEI;AAAM,CAAE,KAC/BJ,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7BA,mBAAmB,KAAK,CAAC,GAC1BI,MAAM,GAAG,CAAC,GACR,CAAC,GACFJ,mBAAmB,KAAK,CAAC,CAAC,GAC3BI,MAAM,GAAG,CAAC,GACR,CAAC,CAAC,GACH,CAAC,CACL,CACD,EACDxB,MAAM,CAACkB,UAAU,CACjB","ignoreList":[]}

package/esm/RoundingOption.js

@@ -1,6 +1,6 @@
 /**
- * This module allows you to round numbers and BigDecimal's according to diverse RoundingMode's with
- * a given precision
+ * This module implements a `CVRoundingOption` which describes the possible options to round a
+ * number or `BigDecimal` and implements the rounding algortithm
  */
 import { MBigDecimal, MBigInt, MInspectable, MNumber, MPipeable, MTypes } from '@parischap/effect-lib';
 import { BigDecimal, Equal, Hash, pipe, Predicate, Struct } from 'effect';
@@ -35,7 +35,7 @@ const proto = {
     return pipe(this.precision, Hash.hash, Hash.combine(Hash.hash(this.roundingMode)), Hash.cached(this));
   },
   [MInspectable.IdSymbol]() {
-    return `${CVRoundingMode.toName(this.roundingMode)}RounderWith${this.precision}Precision`;
+    return `${CVRoundingMode.getName(this.roundingMode)}RounderWith${this.precision}Precision`;
   },
   ... /*#__PURE__*/MInspectable.BaseProto(moduleTag),
   ...MPipeable.BaseProto
@@ -43,7 +43,7 @@ const proto = {
 /** Constructor */
 const _make = params => MTypes.objectFromDataAndProto(proto, params);
 /**
- * Constructor
+ * Constructs a `CVRoundingOption` with the specified `precision` and `roundingMode`
  *
  * @category Constructors
  */
@@ -55,8 +55,8 @@ export const make = ({
   roundingMode
 });
 /**
- * RoundingOption instance that uses the HalfExpand Rounding mode and precision=2. Can be used in
- * accounting apps of most countries.
+ * `CVRoundingOption` instance that uses the `HalfExpand` `CVRoundingMode` and `precision=2`. Can be
+ * used in accounting apps of most countries througout the world
  *
  * @category Instances
  */