@parischap/conversions 0.1.0 → 0.3.0

package/cjs/PositiveInteger.js

@@ -28,8 +28,11 @@ function _interopRequireWildcard(e, t) {
   })(e, t);
 }
 /**
- * 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.
  */
 
 /**
@@ -41,151 +44,163 @@ const moduleTag = exports.moduleTag = '@parischap/conversions/PositiveInteger/';
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 const constructor = exports.constructor = /*#__PURE__*/_effect.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
  */
 const unsafeFromNumber = exports.unsafeFromNumber = /*#__PURE__*/_effect.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
  */
 const fromNumberOption = exports.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
  */
 const fromNumber = exports.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
  */
 const fromNumberOrThrow = exports.fromNumberOrThrow = constructor;
 /**
- * Constructs a PositiveInteger from a BigDecimal without any checks
+ * Constructs a `CVPositiveInteger` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 const unsafeFromBigDecimal = exports.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
  */
 const fromBigDecimalOption = exports.fromBigDecimalOption = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromBigDecimalOption, /*#__PURE__*/_effect.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
  */
 const fromBigDecimal = exports.fromBigDecimal = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromBigDecimal, /*#__PURE__*/_effect.Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveInteger from a BigDecimal or throws
+ * Constructs a `CVPositiveInteger` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromBigDecimalOrThrow = exports.fromBigDecimalOrThrow = /*#__PURE__*/(0, _effect.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
  */
 const unsafeFromBigInt = exports.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
  */
 const fromBigIntOption = exports.fromBigIntOption = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromBigIntOption, /*#__PURE__*/_effect.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
  */
 const fromBigInt = exports.fromBigInt = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromBigInt, /*#__PURE__*/_effect.Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveInteger from a BigInt or throws
+ * Constructs a `CVPositiveInteger` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromBigIntOrThrow = exports.fromBigIntOrThrow = /*#__PURE__*/(0, _effect.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
  */
 const unsafeFromReal = exports.unsafeFromReal = _effect.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
  */
 const fromRealOption = exports.fromRealOption = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromRealOption, /*#__PURE__*/_effect.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
  */
 const fromReal = exports.fromReal = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromReal, /*#__PURE__*/_effect.Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveInteger from a Real or throws
+ * Constructs a `CVPositiveInteger` from a `CVReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromRealOrThrow = exports.fromRealOrThrow = /*#__PURE__*/(0, _effect.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
  */
 const fromIntegerOption = exports.fromIntegerOption = /*#__PURE__*/(0, _effect.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
  */
 const fromInteger = exports.fromInteger = CVPositive.fromNumber;
 /**
- * Constructs a PositiveInteger from an Integer or throws
+ * Constructs a `CVPositiveInteger` from a `CVInteger` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromIntegerOrThrow = exports.fromIntegerOrThrow = /*#__PURE__*/(0, _effect.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
  */
 const fromPositiveRealOption = exports.fromPositiveRealOption = /*#__PURE__*/(0, _effect.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
  */
 const fromPositiveReal = exports.fromPositiveReal = CVInteger.fromReal;
 /**
- * Constructs a PositiveInteger from a PositiveReal or throws
+ * Constructs a `CVPositiveInteger` from a `CVPositiveReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromPositiveRealOrThrow = exports.fromPositiveRealOrThrow = /*#__PURE__*/(0, _effect.flow)(CVInteger.fromRealOrThrow);
 /**
- * A Schema that transforms a number into a CVPositiveInteger.Type
+ * A `Schema` that transforms a number into a `CVPositiveInteger`
  *
- * @internal
+ * @ignore
  */
 const SchemaFromNumber = exports.SchemaFromNumber = /*#__PURE__*/_effect.Schema.Number.pipe(/*#__PURE__*/_effect.Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVPositiveInteger.Type
+ * A Schema that represents a `CVPositiveInteger`
  *
- * @internal
+ * @ignore
  */
 const SchemaFromSelf = exports.SchemaFromSelf = /*#__PURE__*/_effect.Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=PositiveInteger.js.map

package/cjs/PositiveInteger.js.map

@@ -1 +1 @@
-{"version":3,"file":"PositiveInteger.js","names":["_effect","require","CVInteger","_interopRequireWildcard","CVPositive","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","fromIntegerOption","fromInteger","fromIntegerOrThrow","fromPositiveRealOption","fromPositiveReal","fromPositiveRealOrThrow","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveInteger.ts"],"sourcesContent":[null],"mappings":";;;;;;AAMA,IAAAA,OAAA,gBAAAC,OAAA;AACA,IAAAC,SAAA,gBAAAC,uBAAA,cAAAF,OAAA;AACA,IAAAG,UAAA,gBAAAD,uBAAA,cAAAF,OAAA;AAAqD,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;AARrD;;;;;AAYA;;;;;AAKO,MAAMkB,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,yCAAyC;AAElE;;;;;AAKO,MAAME,WAAW,GAAAD,OAAA,CAAAC,WAAA,gBAAG1B,OAAA,CAAA2B,KAAK,CAACC,GAAG,CAAC1B,SAAS,CAACwB,WAAW,EAAEtB,UAAU,CAACsB,WAAW,CAAC;AASnF;;;;;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,GAChCnC,SAAS,CAACmC,oBAA6B;AAExC;;;;;AAKO,MAAMC,oBAAoB,GAAAb,OAAA,CAAAa,oBAAA,gBAG7B,IAAAtC,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACoC,oBAAoB,eAAEtC,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACrC,UAAU,CAAC2B,gBAAgB,CAAC,CAAU;AAE9F;;;;;AAKO,MAAMW,cAAc,GAAAjB,OAAA,CAAAiB,cAAA,gBAGvB,IAAA1C,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACwC,cAAc,eAAE1C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACrC,UAAU,CAAC8B,UAAU,CAAC,CAAU;AAElF;;;;;AAKO,MAAMU,qBAAqB,GAAAnB,OAAA,CAAAmB,qBAAA,gBAAuD,IAAA5C,OAAA,CAAAuC,IAAI,EAC5FrC,SAAS,CAAC0C,qBAAqB,EAC/BxC,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMS,gBAAgB,GAAApB,OAAA,CAAAoB,gBAAA,GAC5B3C,SAAS,CAAC2C,gBAAyB;AAEpC;;;;;AAKO,MAAMC,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,gBAAuD,IAAA9C,OAAA,CAAAuC,IAAI,EACvFrC,SAAS,CAAC4C,gBAAgB,eAC1B9C,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACrC,UAAU,CAAC2B,gBAAgB,CAAC,CAClC;AAEV;;;;;AAKO,MAAMgB,UAAU,GAAAtB,OAAA,CAAAsB,UAAA,gBAGnB,IAAA/C,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAAC6C,UAAU,eAAE/C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACrC,UAAU,CAAC8B,UAAU,CAAC,CAAU;AAE9E;;;;;AAKO,MAAMc,iBAAiB,GAAAvB,OAAA,CAAAuB,iBAAA,gBAAwC,IAAAhD,OAAA,CAAAuC,IAAI,EACzErC,SAAS,CAAC8C,iBAAiB,EAC3B5C,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMa,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,GAA6CjD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAElG;;;;;AAKO,MAAMC,cAAc,GAAA3B,OAAA,CAAA2B,cAAA,gBAA4D,IAAApD,OAAA,CAAAuC,IAAI,EAC1FrC,SAAS,CAACkD,cAAc,eACxBpD,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACrC,UAAU,CAAC2B,gBAAgB,CAAC,CAClC;AAEV;;;;;AAKO,MAAMsB,QAAQ,GAAA5B,OAAA,CAAA4B,QAAA,gBAGjB,IAAArD,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACmD,QAAQ,eAAErD,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACrC,UAAU,CAAC8B,UAAU,CAAC,CAAU;AAE5E;;;;;AAKO,MAAMoB,eAAe,GAAA7B,OAAA,CAAA6B,eAAA,gBAA6C,IAAAtD,OAAA,CAAAuC,IAAI,EAC5ErC,SAAS,CAACoD,eAAe,EACzBlD,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMmB,iBAAiB,GAAA9B,OAAA,CAAA8B,iBAAA,gBAA+D,IAAAvD,OAAA,CAAAuC,IAAI,EAChGnC,UAAU,CAAC2B,gBAAgB,CAClB;AAEV;;;;;AAKO,MAAMyB,WAAW,GAAA/B,OAAA,CAAA+B,WAAA,GAGpBpD,UAAU,CAAC8B,UAAmB;AAElC;;;;;AAKO,MAAMuB,kBAAkB,GAAAhC,OAAA,CAAAgC,kBAAA,gBAAgD,IAAAzD,OAAA,CAAAuC,IAAI,EAClFnC,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMsB,sBAAsB,GAAAjC,OAAA,CAAAiC,sBAAA,gBAG/B,IAAA1D,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACkD,cAAc,CAAU;AAE3C;;;;;AAKO,MAAMO,gBAAgB,GAAAlC,OAAA,CAAAkC,gBAAA,GAGzBzD,SAAS,CAACmD,QAAiB;AAE/B;;;;;AAKO,MAAMO,uBAAuB,GAAAnC,OAAA,CAAAmC,uBAAA,gBAAqD,IAAA5D,OAAA,CAAAuC,IAAI,EAC5FrC,SAAS,CAACoD,eAAe,CAChB;AAEV;;;;;AAKO,MAAMO,gBAAgB,GAAApC,OAAA,CAAAoC,gBAAA,gBAAgC7D,OAAA,CAAA8D,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9EhE,OAAA,CAAA8D,MAAM,CAACG,SAAS,CAACvC,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMwC,cAAc,GAAAzC,OAAA,CAAAyC,cAAA,gBAAwBlE,OAAA,CAAA8D,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"PositiveInteger.js","names":["_effect","require","CVInteger","_interopRequireWildcard","CVPositive","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","fromIntegerOption","fromInteger","fromIntegerOrThrow","fromPositiveRealOption","fromPositiveReal","fromPositiveRealOrThrow","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveInteger.ts"],"sourcesContent":[null],"mappings":";;;;;;AASA,IAAAA,OAAA,gBAAAC,OAAA;AACA,IAAAC,SAAA,gBAAAC,uBAAA,cAAAF,OAAA;AACA,IAAAG,UAAA,gBAAAD,uBAAA,cAAAF,OAAA;AAAqD,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;AAXrD;;;;;;;;AAeA;;;;;AAKO,MAAMkB,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,yCAAyC;AAElE;;;;;AAKO,MAAME,WAAW,GAAAD,OAAA,CAAAC,WAAA,gBAAG1B,OAAA,CAAA2B,KAAK,CAACC,GAAG,CAAC1B,SAAS,CAACwB,WAAW,EAAEtB,UAAU,CAACsB,WAAW,CAAC;AASnF;;;;;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,GAChCnC,SAAS,CAACmC,oBAA6B;AAExC;;;;;;AAMO,MAAMC,oBAAoB,GAAAb,OAAA,CAAAa,oBAAA,gBAG7B,IAAAtC,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACoC,oBAAoB,eAAEtC,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACrC,UAAU,CAAC2B,gBAAgB,CAAC,CAAU;AAE9F;;;;;;AAMO,MAAMW,cAAc,GAAAjB,OAAA,CAAAiB,cAAA,gBAGvB,IAAA1C,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACwC,cAAc,eAAE1C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACrC,UAAU,CAAC8B,UAAU,CAAC,CAAU;AAElF;;;;;AAKO,MAAMU,qBAAqB,GAAAnB,OAAA,CAAAmB,qBAAA,gBAAuD,IAAA5C,OAAA,CAAAuC,IAAI,EAC5FrC,SAAS,CAAC0C,qBAAqB,EAC/BxC,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMS,gBAAgB,GAAApB,OAAA,CAAAoB,gBAAA,GAC5B3C,SAAS,CAAC2C,gBAAyB;AAEpC;;;;;;AAMO,MAAMC,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,gBAAuD,IAAA9C,OAAA,CAAAuC,IAAI,EACvFrC,SAAS,CAAC4C,gBAAgB,eAC1B9C,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACrC,UAAU,CAAC2B,gBAAgB,CAAC,CAClC;AAEV;;;;;;AAMO,MAAMgB,UAAU,GAAAtB,OAAA,CAAAsB,UAAA,gBAGnB,IAAA/C,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAAC6C,UAAU,eAAE/C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACrC,UAAU,CAAC8B,UAAU,CAAC,CAAU;AAE9E;;;;;AAKO,MAAMc,iBAAiB,GAAAvB,OAAA,CAAAuB,iBAAA,gBAAwC,IAAAhD,OAAA,CAAAuC,IAAI,EACzErC,SAAS,CAAC8C,iBAAiB,EAC3B5C,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMa,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,GAA6CjD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAElG;;;;;;AAMO,MAAMC,cAAc,GAAA3B,OAAA,CAAA2B,cAAA,gBAA4D,IAAApD,OAAA,CAAAuC,IAAI,EAC1FrC,SAAS,CAACkD,cAAc,eACxBpD,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACrC,UAAU,CAAC2B,gBAAgB,CAAC,CAClC;AAEV;;;;;;AAMO,MAAMsB,QAAQ,GAAA5B,OAAA,CAAA4B,QAAA,gBAGjB,IAAArD,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACmD,QAAQ,eAAErD,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACrC,UAAU,CAAC8B,UAAU,CAAC,CAAU;AAE5E;;;;;AAKO,MAAMoB,eAAe,GAAA7B,OAAA,CAAA6B,eAAA,gBAA6C,IAAAtD,OAAA,CAAAuC,IAAI,EAC5ErC,SAAS,CAACoD,eAAe,EACzBlD,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;;AAMO,MAAMmB,iBAAiB,GAAA9B,OAAA,CAAA8B,iBAAA,gBAA+D,IAAAvD,OAAA,CAAAuC,IAAI,EAChGnC,UAAU,CAAC2B,gBAAgB,CAClB;AAEV;;;;;;AAMO,MAAMyB,WAAW,GAAA/B,OAAA,CAAA+B,WAAA,GAGpBpD,UAAU,CAAC8B,UAAmB;AAElC;;;;;AAKO,MAAMuB,kBAAkB,GAAAhC,OAAA,CAAAgC,kBAAA,gBAAgD,IAAAzD,OAAA,CAAAuC,IAAI,EAClFnC,UAAU,CAACgC,iBAAiB,CACnB;AAEV;;;;;;AAMO,MAAMsB,sBAAsB,GAAAjC,OAAA,CAAAiC,sBAAA,gBAG/B,IAAA1D,OAAA,CAAAuC,IAAI,EAACrC,SAAS,CAACkD,cAAc,CAAU;AAE3C;;;;;;AAMO,MAAMO,gBAAgB,GAAAlC,OAAA,CAAAkC,gBAAA,GAGzBzD,SAAS,CAACmD,QAAiB;AAE/B;;;;;AAKO,MAAMO,uBAAuB,GAAAnC,OAAA,CAAAmC,uBAAA,gBAAqD,IAAA5D,OAAA,CAAAuC,IAAI,EAC5FrC,SAAS,CAACoD,eAAe,CAChB;AAEV;;;;;AAKO,MAAMO,gBAAgB,GAAApC,OAAA,CAAAoC,gBAAA,gBAAgC7D,OAAA,CAAA8D,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9EhE,OAAA,CAAA8D,MAAM,CAACG,SAAS,CAACvC,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMwC,cAAc,GAAAzC,OAAA,CAAAyC,cAAA,gBAAwBlE,OAAA,CAAA8D,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}

package/cjs/PositiveReal.js

@@ -29,8 +29,10 @@ function _interopRequireWildcard(e, t) {
   })(e, t);
 }
 /**
- * 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.
  */
 
 /**
@@ -42,121 +44,129 @@ const moduleTag = exports.moduleTag = '@parischap/conversions/PositiveReal/';
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 const constructor = exports.constructor = /*#__PURE__*/_effect.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
  */
 const unsafeFromNumber = exports.unsafeFromNumber = /*#__PURE__*/_effect.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
  */
 const fromNumberOption = exports.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
  */
 const fromNumber = exports.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
  */
 const fromNumberOrThrow = exports.fromNumberOrThrow = constructor;
 /**
- * Constructs a PositiveReal from a BigDecimal without any checks
+ * Constructs a `CVPositiveReal` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 const unsafeFromBigDecimal = exports.unsafeFromBigDecimal = _effectLib.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
  */
 const fromBigDecimalOption = exports.fromBigDecimalOption = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigDecimalOption, /*#__PURE__*/_effect.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
  */
 const fromBigDecimal = exports.fromBigDecimal = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigDecimal, /*#__PURE__*/_effect.Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveReal from a BigDecimal or throws
+ * Constructs a `CVPositiveReal` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromBigDecimalOrThrow = exports.fromBigDecimalOrThrow = /*#__PURE__*/(0, _effect.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
  */
 const unsafeFromBigInt = exports.unsafeFromBigInt = _effectLib.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
  */
 const fromBigIntOption = exports.fromBigIntOption = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigIntOption, /*#__PURE__*/_effect.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
  */
 const fromBigInt = exports.fromBigInt = /*#__PURE__*/(0, _effect.flow)(CVReal.fromBigInt, /*#__PURE__*/_effect.Either.flatMap(CVPositive.fromNumber));
 /**
- * Constructs a PositiveReal from a BigInt or throws
+ * Constructs a `CVPositiveReal` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromBigIntOrThrow = exports.fromBigIntOrThrow = /*#__PURE__*/(0, _effect.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
  */
 const unsafeFromReal = exports.unsafeFromReal = _effect.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
  */
 const fromRealOption = exports.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
  */
 const fromReal = exports.fromReal = CVPositive.fromNumber;
 /**
- * Constructs a PositiveReal from a Real or throws
+ * Constructs a `CVPositiveReal` from a `CVReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromRealOrThrow = exports.fromRealOrThrow = CVPositive.fromNumberOrThrow;
 /**
- * Constructs a PositiveReal from a PositiveInteger
+ * Constructs a `CVPositiveReal` from a `CVPositiveInteger`
  *
  * @category Constructors
  */
 const fromPositiveInteger = exports.fromPositiveInteger = _effect.Function.identity;
 /**
- * A Schema that transforms a number into a CVPositiveReal.Type
+ * A `Schema` that transforms a number into a `CVPositiveReal`
  *
- * @internal
+ * @ignore
  */
 const SchemaFromNumber = exports.SchemaFromNumber = /*#__PURE__*/_effect.Schema.Number.pipe(/*#__PURE__*/_effect.Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVPositiveReal.Type
+ * A `Schema` that represents a `CVPositiveReal`
  *
- * @internal
+ * @ignore
  */
 const SchemaFromSelf = exports.SchemaFromSelf = /*#__PURE__*/_effect.Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=PositiveReal.js.map

package/cjs/PositiveReal.js.map

@@ -1 +1 @@
-{"version":3,"file":"PositiveReal.js","names":["_effectLib","require","_effect","CVPositive","_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","MNumber","fromBigDecimalOption","flow","Option","flatMap","fromBigDecimal","Either","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","unsafeFromReal","Function","identity","fromRealOption","fromReal","fromRealOrThrow","fromPositiveInteger","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveReal.ts"],"sourcesContent":[null],"mappings":";;;;;;AAKA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AACA,IAAAE,UAAA,gBAAAC,uBAAA,cAAAH,OAAA;AAEA,IAAAI,MAAA,gBAAAD,uBAAA,cAAAH,OAAA;AAAoC,SAAAG,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;AATpC;;;;;AAWA;;;;;AAKO,MAAMkB,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,sCAAsC;AAE/D;;;;;AAKO,MAAME,WAAW,GAAAD,OAAA,CAAAC,WAAA,gBAAGzB,OAAA,CAAA0B,KAAK,CAACC,GAAG,CAACxB,MAAM,CAACsB,WAAW,EAAExB,UAAU,CAACwB,WAAW,CAAC;AAShF;;;;;AAKO,MAAMG,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,gBAAG5B,OAAA,CAAA0B,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,GAChCtC,UAAA,CAAAuC,OAAO,CAACD,oBAA6B;AAEtC;;;;;AAKO,MAAME,oBAAoB,GAAAd,OAAA,CAAAc,oBAAA,gBAG7B,IAAAtC,OAAA,CAAAuC,IAAI,EAACpC,MAAM,CAACmC,oBAAoB,eAAEtC,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACxC,UAAU,CAAC6B,gBAAgB,CAAC,CAAU;AAE3F;;;;;AAKO,MAAMY,cAAc,GAAAlB,OAAA,CAAAkB,cAAA,gBAGvB,IAAA1C,OAAA,CAAAuC,IAAI,EAACpC,MAAM,CAACuC,cAAc,eAAE1C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACxC,UAAU,CAACgC,UAAU,CAAC,CAAU;AAE/E;;;;;AAKO,MAAMW,qBAAqB,GAAApB,OAAA,CAAAoB,qBAAA,gBAAuD,IAAA5C,OAAA,CAAAuC,IAAI,EAC5FpC,MAAM,CAACyC,qBAAqB,EAC5B3C,UAAU,CAACkC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMU,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,GAC5B/C,UAAA,CAAAuC,OAAO,CAACQ,gBAAyB;AAElC;;;;;AAKO,MAAMC,gBAAgB,GAAAtB,OAAA,CAAAsB,gBAAA,gBAAuD,IAAA9C,OAAA,CAAAuC,IAAI,EACvFpC,MAAM,CAAC2C,gBAAgB,eACvB9C,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACxC,UAAU,CAAC6B,gBAAgB,CAAC,CAClC;AAEV;;;;;AAKO,MAAMiB,UAAU,GAAAvB,OAAA,CAAAuB,UAAA,gBAGnB,IAAA/C,OAAA,CAAAuC,IAAI,EAACpC,MAAM,CAAC4C,UAAU,eAAE/C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACxC,UAAU,CAACgC,UAAU,CAAC,CAAU;AAE3E;;;;;AAKO,MAAMe,iBAAiB,GAAAxB,OAAA,CAAAwB,iBAAA,gBAAwC,IAAAhD,OAAA,CAAAuC,IAAI,EACzEpC,MAAM,CAAC6C,iBAAiB,EACxB/C,UAAU,CAACkC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMc,cAAc,GAAAzB,OAAA,CAAAyB,cAAA,GAA6CjD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAElG;;;;;AAKO,MAAMC,cAAc,GAAA5B,OAAA,CAAA4B,cAAA,GAGvBnD,UAAU,CAAC6B,gBAAyB;AAExC;;;;;AAKO,MAAMuB,QAAQ,GAAA7B,OAAA,CAAA6B,QAAA,GAGjBpD,UAAU,CAACgC,UAAmB;AAElC;;;;;AAKO,MAAMqB,eAAe,GAAA9B,OAAA,CAAA8B,eAAA,GAC3BrD,UAAU,CAACkC,iBAA0B;AAEtC;;;;;AAKO,MAAMoB,mBAAmB,GAAA/B,OAAA,CAAA+B,mBAAA,GAC/BvD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAE3B;;;;;AAKO,MAAMK,gBAAgB,GAAAhC,OAAA,CAAAgC,gBAAA,gBAAgCxD,OAAA,CAAAyD,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9E3D,OAAA,CAAAyD,MAAM,CAACG,SAAS,CAACnC,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMoC,cAAc,GAAArC,OAAA,CAAAqC,cAAA,gBAAwB7D,OAAA,CAAAyD,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"PositiveReal.js","names":["_effectLib","require","_effect","CVPositive","_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","MNumber","fromBigDecimalOption","flow","Option","flatMap","fromBigDecimal","Either","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","unsafeFromReal","Function","identity","fromRealOption","fromReal","fromRealOrThrow","fromPositiveInteger","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/PositiveReal.ts"],"sourcesContent":[null],"mappings":";;;;;;AAOA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AACA,IAAAE,UAAA,gBAAAC,uBAAA,cAAAH,OAAA;AAEA,IAAAI,MAAA,gBAAAD,uBAAA,cAAAH,OAAA;AAAoC,SAAAG,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;AAXpC;;;;;;;AAaA;;;;;AAKO,MAAMkB,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,sCAAsC;AAE/D;;;;;AAKO,MAAME,WAAW,GAAAD,OAAA,CAAAC,WAAA,gBAAGzB,OAAA,CAAA0B,KAAK,CAACC,GAAG,CAACxB,MAAM,CAACsB,WAAW,EAAExB,UAAU,CAACwB,WAAW,CAAC;AAShF;;;;;AAKO,MAAMG,gBAAgB,GAAAJ,OAAA,CAAAI,gBAAA,gBAAG5B,OAAA,CAAA0B,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,GAChCtC,UAAA,CAAAuC,OAAO,CAACD,oBAA6B;AAEtC;;;;;;AAMO,MAAME,oBAAoB,GAAAd,OAAA,CAAAc,oBAAA,gBAG7B,IAAAtC,OAAA,CAAAuC,IAAI,EAACpC,MAAM,CAACmC,oBAAoB,eAAEtC,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACxC,UAAU,CAAC6B,gBAAgB,CAAC,CAAU;AAE3F;;;;;;AAMO,MAAMY,cAAc,GAAAlB,OAAA,CAAAkB,cAAA,gBAGvB,IAAA1C,OAAA,CAAAuC,IAAI,EAACpC,MAAM,CAACuC,cAAc,eAAE1C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACxC,UAAU,CAACgC,UAAU,CAAC,CAAU;AAE/E;;;;;AAKO,MAAMW,qBAAqB,GAAApB,OAAA,CAAAoB,qBAAA,gBAAuD,IAAA5C,OAAA,CAAAuC,IAAI,EAC5FpC,MAAM,CAACyC,qBAAqB,EAC5B3C,UAAU,CAACkC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMU,gBAAgB,GAAArB,OAAA,CAAAqB,gBAAA,GAC5B/C,UAAA,CAAAuC,OAAO,CAACQ,gBAAyB;AAElC;;;;;;AAMO,MAAMC,gBAAgB,GAAAtB,OAAA,CAAAsB,gBAAA,gBAAuD,IAAA9C,OAAA,CAAAuC,IAAI,EACvFpC,MAAM,CAAC2C,gBAAgB,eACvB9C,OAAA,CAAAwC,MAAM,CAACC,OAAO,CAACxC,UAAU,CAAC6B,gBAAgB,CAAC,CAClC;AAEV;;;;;;AAMO,MAAMiB,UAAU,GAAAvB,OAAA,CAAAuB,UAAA,gBAGnB,IAAA/C,OAAA,CAAAuC,IAAI,EAACpC,MAAM,CAAC4C,UAAU,eAAE/C,OAAA,CAAA2C,MAAM,CAACF,OAAO,CAACxC,UAAU,CAACgC,UAAU,CAAC,CAAU;AAE3E;;;;;AAKO,MAAMe,iBAAiB,GAAAxB,OAAA,CAAAwB,iBAAA,gBAAwC,IAAAhD,OAAA,CAAAuC,IAAI,EACzEpC,MAAM,CAAC6C,iBAAiB,EACxB/C,UAAU,CAACkC,iBAAiB,CACnB;AAEV;;;;;AAKO,MAAMc,cAAc,GAAAzB,OAAA,CAAAyB,cAAA,GAA6CjD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAElG;;;;;;AAMO,MAAMC,cAAc,GAAA5B,OAAA,CAAA4B,cAAA,GAGvBnD,UAAU,CAAC6B,gBAAyB;AAExC;;;;;;AAMO,MAAMuB,QAAQ,GAAA7B,OAAA,CAAA6B,QAAA,GAGjBpD,UAAU,CAACgC,UAAmB;AAElC;;;;;AAKO,MAAMqB,eAAe,GAAA9B,OAAA,CAAA8B,eAAA,GAC3BrD,UAAU,CAACkC,iBAA0B;AAEtC;;;;;AAKO,MAAMoB,mBAAmB,GAAA/B,OAAA,CAAA+B,mBAAA,GAC/BvD,OAAA,CAAAkD,QAAQ,CAACC,QAAiB;AAE3B;;;;;AAKO,MAAMK,gBAAgB,GAAAhC,OAAA,CAAAgC,gBAAA,gBAAgCxD,OAAA,CAAAyD,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9E3D,OAAA,CAAAyD,MAAM,CAACG,SAAS,CAACnC,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAMoC,cAAc,GAAArC,OAAA,CAAAqC,cAAA,gBAAwB7D,OAAA,CAAAyD,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}

package/cjs/Real.js

@@ -6,7 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.unsafeFromNumber = exports.unsafeFromBigInt = exports.unsafeFromBigDecimal = exports.moduleTag = exports.fromNumberOrThrow = exports.fromNumberOption = exports.fromNumber = exports.fromBigIntOrThrow = exports.fromBigIntOption = exports.fromBigInt = exports.fromBigDecimalOrThrow = exports.fromBigDecimalOption = exports.fromBigDecimal = exports.constructor = exports.TypeId = exports.SchemaFromSelf = exports.SchemaFromNumber = void 0;
 var _effectLib = /*#__PURE__*/require("@parischap/effect-lib");
 var _effect = /*#__PURE__*/require("effect");
-/** 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.
+ */
 
 /**
  * Module tag
@@ -23,91 +28,97 @@ const TypeId = exports.TypeId = /*#__PURE__*/Symbol.for(moduleTag);
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 const constructor = exports.constructor = /*#__PURE__*/_effect.Brand.refined(_effectLib.MNumber.isFinite, /*#__PURE__*/(0, _effect.flow)(/*#__PURE__*/_effectLib.MString.fromNumber(10), /*#__PURE__*/_effectLib.MString.prepend("'"), /*#__PURE__*/_effectLib.MString.append("' does not represent a finite number"), _effect.Brand.error));
 /**
- * Constructs a Real from a number without any verifications
+ * Constructs a `CVReal` from a number without any verifications
  *
  * @category Constructors
  */
 const unsafeFromNumber = exports.unsafeFromNumber = /*#__PURE__*/_effect.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
  */
 const fromNumberOption = exports.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
  */
 const fromNumber = exports.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
  */
 const fromNumberOrThrow = exports.fromNumberOrThrow = constructor;
 /**
- * Constructs a Real from a BigDecimal without any checks
+ * Constructs a `CVReal` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 const unsafeFromBigDecimal = exports.unsafeFromBigDecimal = _effectLib.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
  */
 const fromBigDecimalOption = exports.fromBigDecimalOption = _effectLib.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
  */
 const fromBigDecimal = exports.fromBigDecimal = _effectLib.MNumber.fromBigDecimal;
 /**
- * Constructs a Real from a BigDecimal or throws
+ * Constructs a `CVReal` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromBigDecimalOrThrow = exports.fromBigDecimalOrThrow = _effectLib.MNumber.fromBigDecimalOrThrow;
 /**
- * Constructs a Real from a BigInt without any checks
+ * Constructs a `CVReal` from a `BigInt` without any checks
  *
  * @category Constructors
  */
 const unsafeFromBigInt = exports.unsafeFromBigInt = _effectLib.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
  */
 const fromBigIntOption = exports.fromBigIntOption = _effectLib.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
  */
 const fromBigInt = exports.fromBigInt = _effectLib.MNumber.fromBigInt;
 /**
- * Constructs a Real from a BigInt or throws
+ * Constructs a `CVReal` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 const fromBigIntOrThrow = exports.fromBigIntOrThrow = _effectLib.MNumber.fromBigIntOrThrow;
 /**
- * A Schema that transforms a number into an CVReal.Type
+ * A `Schema` that transforms a number into a `CVReal`
  *
- * @internal
+ * @ignore
  */
 const SchemaFromNumber = exports.SchemaFromNumber = /*#__PURE__*/_effect.Schema.Number.pipe(/*#__PURE__*/_effect.Schema.fromBrand(constructor));
 /**
- * A Schema that represents a CVReal.Type
+ * A `Schema` that represents a `CVReal`
  *
- * @internal
+ * @ignore
  */
 const SchemaFromSelf = exports.SchemaFromSelf = /*#__PURE__*/_effect.Schema.typeSchema(SchemaFromNumber);
 //# sourceMappingURL=Real.js.map

package/cjs/Real.js.map

@@ -1 +1 @@
-{"version":3,"file":"Real.js","names":["_effectLib","require","_effect","moduleTag","exports","TypeId","Symbol","for","constructor","Brand","refined","MNumber","isFinite","flow","MString","fromNumber","prepend","append","error","unsafeFromNumber","nominal","fromNumberOption","option","bind","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","fromBigDecimal","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Real.ts"],"sourcesContent":[null],"mappings":";;;;;;AAEA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AAHA;;AAKA;;;;;AAKO,MAAME,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,8BAA8B;AAEvD;;;;;AAKO,MAAME,MAAM,GAAAD,OAAA,CAAAC,MAAA,gBAAkBC,MAAM,CAACC,GAAG,CAACJ,SAAS,CAAY;AAUrE;;;;;AAKO,MAAMK,WAAW,GAAAJ,OAAA,CAAAI,WAAA,gBAAGN,OAAA,CAAAO,KAAK,CAACC,OAAO,CACvCV,UAAA,CAAAW,OAAO,CAACC,QAAQ,eAChB,IAAAV,OAAA,CAAAW,IAAI,eACHb,UAAA,CAAAc,OAAO,CAACC,UAAU,CAAC,EAAE,CAAC,eACtBf,UAAA,CAAAc,OAAO,CAACE,OAAO,CAAC,GAAG,CAAC,eACpBhB,UAAA,CAAAc,OAAO,CAACG,MAAM,CAAC,sCAAsC,CAAC,EACtDf,OAAA,CAAAO,KAAK,CAACS,KAAK,CACX,CACD;AAED;;;;;AAKO,MAAMC,gBAAgB,GAAAf,OAAA,CAAAe,gBAAA,gBAAGjB,OAAA,CAAAO,KAAK,CAACW,OAAO,EAAQ;AAErD;;;;;AAKO,MAAMC,gBAAgB,GAAAjB,OAAA,CAAAiB,gBAAA,gBAGzBb,WAAW,CAACc,MAAM,CAACC,IAAI,CAACf,WAAW,CAAC;AAExC;;;;;AAKO,MAAMO,UAAU,GAAAX,OAAA,CAAAW,UAAA,gBAGnBP,WAAW,CAACgB,MAAM,CAACD,IAAI,CAACf,WAAW,CAAC;AAExC;;;;;AAKO,MAAMiB,iBAAiB,GAAArB,OAAA,CAAAqB,iBAAA,GAAwCjB,WAAW;AAEjF;;;;;AAKO,MAAMkB,oBAAoB,GAAAtB,OAAA,CAAAsB,oBAAA,GAChC1B,UAAA,CAAAW,OAAO,CAACe,oBAA6B;AAEtC;;;;;AAKO,MAAMC,oBAAoB,GAAAvB,OAAA,CAAAuB,oBAAA,GAG7B3B,UAAA,CAAAW,OAAO,CAACgB,oBAA6B;AAEzC;;;;;AAKO,MAAMC,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,GAGvB5B,UAAA,CAAAW,OAAO,CAACiB,cAAuB;AAEnC;;;;;AAKO,MAAMC,qBAAqB,GAAAzB,OAAA,CAAAyB,qBAAA,GACjC7B,UAAA,CAAAW,OAAO,CAACkB,qBAA8B;AAEvC;;;;;AAKO,MAAMC,gBAAgB,GAAA1B,OAAA,CAAA0B,gBAAA,GAC5B9B,UAAA,CAAAW,OAAO,CAACmB,gBAAyB;AAElC;;;;;AAKO,MAAMC,gBAAgB,GAAA3B,OAAA,CAAA2B,gBAAA,GAGzB/B,UAAA,CAAAW,OAAO,CAACoB,gBAAyB;AAErC;;;;;AAKO,MAAMC,UAAU,GAAA5B,OAAA,CAAA4B,UAAA,GAGnBhC,UAAA,CAAAW,OAAO,CAACqB,UAAmB;AAE/B;;;;;AAKO,MAAMC,iBAAiB,GAAA7B,OAAA,CAAA6B,iBAAA,GAC7BjC,UAAA,CAAAW,OAAO,CAACsB,iBAA0B;AAEnC;;;;;AAKO,MAAMC,gBAAgB,GAAA9B,OAAA,CAAA8B,gBAAA,gBAAgChC,OAAA,CAAAiC,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9EnC,OAAA,CAAAiC,MAAM,CAACG,SAAS,CAAC9B,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAM+B,cAAc,GAAAnC,OAAA,CAAAmC,cAAA,gBAAwBrC,OAAA,CAAAiC,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}
+{"version":3,"file":"Real.js","names":["_effectLib","require","_effect","moduleTag","exports","TypeId","Symbol","for","constructor","Brand","refined","MNumber","isFinite","flow","MString","fromNumber","prepend","append","error","unsafeFromNumber","nominal","fromNumberOption","option","bind","either","fromNumberOrThrow","unsafeFromBigDecimal","fromBigDecimalOption","fromBigDecimal","fromBigDecimalOrThrow","unsafeFromBigInt","fromBigIntOption","fromBigInt","fromBigIntOrThrow","SchemaFromNumber","Schema","Number","pipe","fromBrand","SchemaFromSelf","typeSchema"],"sources":["../../esm/Real.ts"],"sourcesContent":[null],"mappings":";;;;;;AAOA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AARA;;;;;;;AAUA;;;;;AAKO,MAAME,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,8BAA8B;AAEvD;;;;;AAKO,MAAME,MAAM,GAAAD,OAAA,CAAAC,MAAA,gBAAkBC,MAAM,CAACC,GAAG,CAACJ,SAAS,CAAY;AAUrE;;;;;AAKO,MAAMK,WAAW,GAAAJ,OAAA,CAAAI,WAAA,gBAAGN,OAAA,CAAAO,KAAK,CAACC,OAAO,CACvCV,UAAA,CAAAW,OAAO,CAACC,QAAQ,eAChB,IAAAV,OAAA,CAAAW,IAAI,eACHb,UAAA,CAAAc,OAAO,CAACC,UAAU,CAAC,EAAE,CAAC,eACtBf,UAAA,CAAAc,OAAO,CAACE,OAAO,CAAC,GAAG,CAAC,eACpBhB,UAAA,CAAAc,OAAO,CAACG,MAAM,CAAC,sCAAsC,CAAC,EACtDf,OAAA,CAAAO,KAAK,CAACS,KAAK,CACX,CACD;AAED;;;;;AAKO,MAAMC,gBAAgB,GAAAf,OAAA,CAAAe,gBAAA,gBAAGjB,OAAA,CAAAO,KAAK,CAACW,OAAO,EAAQ;AAErD;;;;;;AAMO,MAAMC,gBAAgB,GAAAjB,OAAA,CAAAiB,gBAAA,gBAGzBb,WAAW,CAACc,MAAM,CAACC,IAAI,CAACf,WAAW,CAAC;AAExC;;;;;;AAMO,MAAMO,UAAU,GAAAX,OAAA,CAAAW,UAAA,gBAGnBP,WAAW,CAACgB,MAAM,CAACD,IAAI,CAACf,WAAW,CAAC;AAExC;;;;;AAKO,MAAMiB,iBAAiB,GAAArB,OAAA,CAAAqB,iBAAA,GAAwCjB,WAAW;AAEjF;;;;;AAKO,MAAMkB,oBAAoB,GAAAtB,OAAA,CAAAsB,oBAAA,GAChC1B,UAAA,CAAAW,OAAO,CAACe,oBAA6B;AAEtC;;;;;;AAMO,MAAMC,oBAAoB,GAAAvB,OAAA,CAAAuB,oBAAA,GAG7B3B,UAAA,CAAAW,OAAO,CAACgB,oBAA6B;AAEzC;;;;;;AAMO,MAAMC,cAAc,GAAAxB,OAAA,CAAAwB,cAAA,GAGvB5B,UAAA,CAAAW,OAAO,CAACiB,cAAuB;AAEnC;;;;;AAKO,MAAMC,qBAAqB,GAAAzB,OAAA,CAAAyB,qBAAA,GACjC7B,UAAA,CAAAW,OAAO,CAACkB,qBAA8B;AAEvC;;;;;AAKO,MAAMC,gBAAgB,GAAA1B,OAAA,CAAA0B,gBAAA,GAC5B9B,UAAA,CAAAW,OAAO,CAACmB,gBAAyB;AAElC;;;;;;AAMO,MAAMC,gBAAgB,GAAA3B,OAAA,CAAA2B,gBAAA,GAGzB/B,UAAA,CAAAW,OAAO,CAACoB,gBAAyB;AAErC;;;;;;AAMO,MAAMC,UAAU,GAAA5B,OAAA,CAAA4B,UAAA,GAGnBhC,UAAA,CAAAW,OAAO,CAACqB,UAAmB;AAE/B;;;;;AAKO,MAAMC,iBAAiB,GAAA7B,OAAA,CAAA6B,iBAAA,GAC7BjC,UAAA,CAAAW,OAAO,CAACsB,iBAA0B;AAEnC;;;;;AAKO,MAAMC,gBAAgB,GAAA9B,OAAA,CAAA8B,gBAAA,gBAAgChC,OAAA,CAAAiC,MAAM,CAACC,MAAM,CAACC,IAAI,cAC9EnC,OAAA,CAAAiC,MAAM,CAACG,SAAS,CAAC9B,WAAW,CAAC,CAC7B;AAED;;;;;AAKO,MAAM+B,cAAc,GAAAnC,OAAA,CAAAmC,cAAA,gBAAwBrC,OAAA,CAAAiC,MAAM,CAACK,UAAU,CAACN,gBAAgB,CAAC","ignoreList":[]}

package/cjs/RoundingMode.js

@@ -3,13 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.toName = exports.toCorrecter = exports.Type = void 0;
+exports.toCorrecter = exports.getName = exports.Type = void 0;
 var _effectLib = /*#__PURE__*/require("@parischap/effect-lib");
 var _effect = /*#__PURE__*/require("effect");
-/** 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)
+ */
 
 /**
- * Possible rounding modes
+ * Type that represents the possible rounding modes
  *
  * @category Models
  */
@@ -61,7 +64,7 @@ var Type;
  *
  * @category Destructors
  */
-const toName = exports.toName = /*#__PURE__*/(0, _effect.flow)(_effectLib.MMatch.make, /*#__PURE__*/(0, _effect.flow)(/*#__PURE__*/_effectLib.MMatch.whenIs(Type.Ceil, /*#__PURE__*/_effect.Function.constant('Ceil')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.Floor, /*#__PURE__*/_effect.Function.constant('Floor')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.Expand, /*#__PURE__*/_effect.Function.constant('Expand')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.Trunc, /*#__PURE__*/_effect.Function.constant('Trunc')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfCeil, /*#__PURE__*/_effect.Function.constant('HalfCeil')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfFloor, /*#__PURE__*/_effect.Function.constant('HalfFloor')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfExpand, /*#__PURE__*/_effect.Function.constant('HalfExpand')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfTrunc, /*#__PURE__*/_effect.Function.constant('HalfTrunc')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfEven, /*#__PURE__*/_effect.Function.constant('HalfEven'))), _effectLib.MMatch.exhaustive);
+const getName = exports.getName = /*#__PURE__*/(0, _effect.flow)(_effectLib.MMatch.make, /*#__PURE__*/(0, _effect.flow)(/*#__PURE__*/_effectLib.MMatch.whenIs(Type.Ceil, /*#__PURE__*/_effect.Function.constant('Ceil')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.Floor, /*#__PURE__*/_effect.Function.constant('Floor')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.Expand, /*#__PURE__*/_effect.Function.constant('Expand')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.Trunc, /*#__PURE__*/_effect.Function.constant('Trunc')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfCeil, /*#__PURE__*/_effect.Function.constant('HalfCeil')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfFloor, /*#__PURE__*/_effect.Function.constant('HalfFloor')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfExpand, /*#__PURE__*/_effect.Function.constant('HalfExpand')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfTrunc, /*#__PURE__*/_effect.Function.constant('HalfTrunc')), /*#__PURE__*/_effectLib.MMatch.whenIs(Type.HalfEven, /*#__PURE__*/_effect.Function.constant('HalfEven'))), _effectLib.MMatch.exhaustive);
 /**
  * Builds a `Correcter` implementing `self`
  *

package/cjs/RoundingMode.js.map

@@ -1 +1 @@
-{"version":3,"file":"RoundingMode.js","names":["_effectLib","require","_effect","Type","exports","toName","flow","MMatch","make","whenIs","Ceil","Function","constant","Floor","Expand","Trunc","HalfCeil","HalfFloor","HalfExpand","HalfTrunc","HalfEven","exhaustive","toCorrecter","firstFollowingDigit","Struct","get","Math","sign","isEven"],"sources":["../../esm/RoundingMode.ts"],"sourcesContent":[null],"mappings":";;;;;;AAEA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AAHA;;AAKA;;;;;AAKA,IAAYE,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,KAAAC,OAAA,CAAAD,IAAA,GAAJA,IAAI;AA2ChB;;;;;AAKO,MAAME,MAAM,GAAAD,OAAA,CAAAC,MAAA,gBAAwC,IAAAH,OAAA,CAAAI,IAAI,EAC9DN,UAAA,CAAAO,MAAM,CAACC,IAAI,eACX,IAAAN,OAAA,CAAAI,IAAI,eACHN,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACO,IAAI,eAAER,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,MAAM,CAAC,CAAC,eACnDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACU,KAAK,eAAEX,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACW,MAAM,eAAEZ,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,QAAQ,CAAC,CAAC,eACvDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACY,KAAK,eAAEb,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACa,QAAQ,eAAEd,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,UAAU,CAAC,CAAC,eAC3DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACc,SAAS,eAAEf,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACe,UAAU,eAAEhB,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,YAAY,CAAC,CAAC,eAC/DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACgB,SAAS,eAAEjB,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACiB,QAAQ,eAAElB,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAC3D,EACDZ,UAAA,CAAAO,MAAM,CAACc,UAAU,CACjB;AAgBD;;;;;AAKO,MAAMC,WAAW,GAAAlB,OAAA,CAAAkB,WAAA,gBAA2C,IAAApB,OAAA,CAAAI,IAAI,EACtEN,UAAA,CAAAO,MAAM,CAACC,IAAI,eACX,IAAAN,OAAA,CAAAI,IAAI,eACHN,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACO,IAAI,EACT,MACC,CAAC;EAAEa;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CACjC,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACU,KAAK,EACV,MACC,CAAC;EAAEU;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAClC,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACW,MAAM,EAAE,MAAiB,IAAAZ,OAAA,CAAAI,IAAI,EAACJ,OAAA,CAAAsB,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC,EAAEC,IAAI,CAACC,IAAI,CAAC,CAAC,eAC/F3B,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACY,KAAK,EAAE,MAAiBb,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,CAAC,CAAC,CAAC,eAChEZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACa,QAAQ,EACb,MACC,CAAC;EAAEO;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACc,SAAS,EACd,MACC,CAAC;EAAEM;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACe,UAAU,EACf,MACC,CAAC;EAAEK;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACgB,SAAS,EACd,MACC,CAAC;EAAEI;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACiB,QAAQ,EACb,MACC,CAAC;EAAEG,mBAAmB;EAAEK;AAAM,CAAE,KAC/BL,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7BA,mBAAmB,KAAK,CAAC,GAC1BK,MAAM,GAAG,CAAC,GACR,CAAC,GACFL,mBAAmB,KAAK,CAAC,CAAC,GAC3BK,MAAM,GAAG,CAAC,GACR,CAAC,CAAC,GACH,CAAC,CACL,CACD,EACD5B,UAAA,CAAAO,MAAM,CAACc,UAAU,CACjB","ignoreList":[]}
+{"version":3,"file":"RoundingMode.js","names":["_effectLib","require","_effect","Type","exports","getName","flow","MMatch","make","whenIs","Ceil","Function","constant","Floor","Expand","Trunc","HalfCeil","HalfFloor","HalfExpand","HalfTrunc","HalfEven","exhaustive","toCorrecter","firstFollowingDigit","Struct","get","Math","sign","isEven"],"sources":["../../esm/RoundingMode.ts"],"sourcesContent":[null],"mappings":";;;;;;AAKA,IAAAA,UAAA,gBAAAC,OAAA;AACA,IAAAC,OAAA,gBAAAD,OAAA;AANA;;;;;AAQA;;;;;AAKA,IAAYE,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,KAAAC,OAAA,CAAAD,IAAA,GAAJA,IAAI;AA2ChB;;;;;AAKO,MAAME,OAAO,GAAAD,OAAA,CAAAC,OAAA,gBAAwC,IAAAH,OAAA,CAAAI,IAAI,EAC/DN,UAAA,CAAAO,MAAM,CAACC,IAAI,eACX,IAAAN,OAAA,CAAAI,IAAI,eACHN,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACO,IAAI,eAAER,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,MAAM,CAAC,CAAC,eACnDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACU,KAAK,eAAEX,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACW,MAAM,eAAEZ,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,QAAQ,CAAC,CAAC,eACvDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACY,KAAK,eAAEb,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,OAAO,CAAC,CAAC,eACrDZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACa,QAAQ,eAAEd,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,UAAU,CAAC,CAAC,eAC3DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACc,SAAS,eAAEf,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACe,UAAU,eAAEhB,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,YAAY,CAAC,CAAC,eAC/DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACgB,SAAS,eAAEjB,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,WAAW,CAAC,CAAC,eAC7DZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACiB,QAAQ,eAAElB,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAC3D,EACDZ,UAAA,CAAAO,MAAM,CAACc,UAAU,CACjB;AAgBD;;;;;AAKO,MAAMC,WAAW,GAAAlB,OAAA,CAAAkB,WAAA,gBAA2C,IAAApB,OAAA,CAAAI,IAAI,EACtEN,UAAA,CAAAO,MAAM,CAACC,IAAI,eACX,IAAAN,OAAA,CAAAI,IAAI,eACHN,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACO,IAAI,EACT,MACC,CAAC;EAAEa;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CACjC,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACU,KAAK,EACV,MACC,CAAC;EAAEU;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAClC,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACW,MAAM,EAAE,MAAiB,IAAAZ,OAAA,CAAAI,IAAI,EAACJ,OAAA,CAAAsB,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAAC,EAAEC,IAAI,CAACC,IAAI,CAAC,CAAC,eAC/F3B,UAAA,CAAAO,MAAM,CAACE,MAAM,CAACN,IAAI,CAACY,KAAK,EAAE,MAAiBb,OAAA,CAAAS,QAAQ,CAACC,QAAQ,CAAC,CAAC,CAAC,CAAC,eAChEZ,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACa,QAAQ,EACb,MACC,CAAC;EAAEO;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACc,SAAS,EACd,MACC,CAAC;EAAEM;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACe,UAAU,EACf,MACC,CAAC;EAAEK;AAAmB,CAAE,KACvBA,mBAAmB,IAAI,CAAC,GAAG,CAAC,GAC1BA,mBAAmB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAC9B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACgB,SAAS,EACd,MACC,CAAC;EAAEI;AAAmB,CAAE,KACvBA,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7B,CAAC,CACL,eACDvB,UAAA,CAAAO,MAAM,CAACE,MAAM,CACZN,IAAI,CAACiB,QAAQ,EACb,MACC,CAAC;EAAEG,mBAAmB;EAAEK;AAAM,CAAE,KAC/BL,mBAAmB,GAAG,CAAC,GAAG,CAAC,GACzBA,mBAAmB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAC7BA,mBAAmB,KAAK,CAAC,GAC1BK,MAAM,GAAG,CAAC,GACR,CAAC,GACFL,mBAAmB,KAAK,CAAC,CAAC,GAC3BK,MAAM,GAAG,CAAC,GACR,CAAC,CAAC,GACH,CAAC,CACL,CACD,EACD5B,UAAA,CAAAO,MAAM,CAACc,UAAU,CACjB","ignoreList":[]}