@parischap/conversions 0.1.0 → 0.2.0

package/dts/NumberBase10Format.d.ts

@@ -1,6 +1,6 @@
 /**
- * This module implements conversions from number to string and string to number in base-10
- * notation.
+ * This module implements a `CVNumberBase10Format` which describes the possible options to
+ * format/parse a base-10 number or `BigDecimal` and implements the formatting/parsing algortithms
  */
 import { MTypes } from '@parischap/effect-lib';
 import { BigDecimal, Inspectable, Option, Pipeable } from 'effect';
@@ -13,7 +13,7 @@ import * as CVRoundingMode from './RoundingMode.js';
  */
 export declare const moduleTag = "@parischap/conversions/NumberBase10Format/";
 /**
- * Possible sign display options
+ * Type that represents the possible sign display options
  *
  * @category Models
  */
@@ -57,13 +57,13 @@ export declare enum SignDisplay {
  */
 export declare namespace SignDisplay {
     /**
-     * Type that represents the possible strings for a sign
+     * Type that represents the possible strings used to represent a sign
      *
      * @category Models
      */
     type SignString = '-' | '+' | '';
     /**
-     * Type that represents the possible values for a sign
+     * Type that represents the possible values of a sign
      *
      * @category Models
      */
@@ -102,7 +102,7 @@ export declare namespace SignDisplay {
     const toFormatter: MTypes.OneArgFunction<SignDisplay, Formatter>;
 }
 /**
- * Possible scientific notation options
+ * Type that represents the possible scientific notation options
  *
  * @category Models
  */
@@ -140,7 +140,7 @@ export declare enum ScientificNotation {
     Engineering = 3
 }
 /**
- * Namespace for possible scientific notation options
+ * ScientificNotation namespace
  *
  * @category Models
  */
@@ -186,7 +186,7 @@ export declare namespace ScientificNotation {
     const toMantissaAdjuster: MTypes.OneArgFunction<ScientificNotation, MantissaAdjuster>;
 }
 /**
- * Type that represents a NumberBase10Format
+ * Type that represents a `CVNumberBase10Format`
  *
  * @category Models
  */
@@ -320,7 +320,7 @@ export declare const roundingMode: MTypes.OneArgFunction<Type, CVRoundingMode.Ty
  */
 export declare const signDisplay: MTypes.OneArgFunction<Type, SignDisplay>;
 /**
- * Returns a short description of `self`
+ * Returns a short description of `self`, e.g. 'signed integer'
  *
  * @category Destructors
  */
@@ -328,47 +328,47 @@ export declare const toDescription: (self: Type) => string;
 /**
  * Returns a function that tries to parse, from the start of a string `text`, a number respecting
  * the options represented by `self` and an optional `fillChar` parameter. If successful, that
- * function returns a `some` containing `parsedText` (the part of `text` that could be analyzed as
+ * function returns a `Some` containing `parsedText` (the part of `text` that could be analyzed as
  * representing a number) and `value` (`parsedText` converted to a BigDecimal value). Otherwise, it
- * returns a `none`. As there is no way to distinguish `-0n` and `0n` in Javascript, parsing '-0',
- * '0', '+0' will yield the same result.
+ * returns a `None`. As `BigDecimal`'s provide no possibility to distinguish `-0n` and `0n`, parsing
+ * '-0', '0', '+0' will yield the same result.
  *
  * `fillChar` is a character that may be used as filler between the sign and the number (or at the
  * start of the number if it is unsigned). It must be a one-character string (but no error is
- * triggered if it's not). You can use '0' as `fillChar` but you shoud not use any other digit
+ * triggered if it's not). You can use '0' as `fillChar` but you should not use any other digit
  * because the value of the number to parse would depend on the number of removed `fillChar`'s.
  *
  * @category Parsing
  */
 export declare const toBigDecimalExtractor: (self: Type, fillChar?: string) => MTypes.OneArgFunction<string, Option.Option<MTypes.Pair<BigDecimal.BigDecimal, string>>>;
 /**
- * Same as toBigDecimalExtractor but the returned parser throws in case of error
+ * Same as `toBigDecimalExtractor` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
 export declare const toThrowingBigDecimalExtractor: (self: Type, fillChar?: string) => (text: string) => MTypes.Pair<BigDecimal.BigDecimal, string>;
 /**
- * Same as `toBigDecimalExtractor` but returns a `Real` which is the most usual use case.
- * Furthermore, this function will return -0 if your parse '-0' and 0 if you parse '0' or '+0'.
+ * Same as `toBigDecimalExtractor` but returns a `CVReal`. This is the most usual use case.
+ * Furthermore, this function will return `-0` if your parse '-0' and `0` if you parse '0' or '+0'.
  *
  * @category Parsing
  */
 export declare const toRealExtractor: (self: Type, fillChar?: string) => MTypes.OneArgFunction<string, Option.Option<MTypes.Pair<CVReal.Type, string>>>;
 /**
- * Same as toRealExtractor but the returned parser throws in case of error
+ * Same as `toRealExtractor` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
 export declare const toThrowingRealExtractor: (self: Type, fillChar?: string) => (text: string) => MTypes.Pair<CVReal.Type, string>;
 /**
- * Same as toBigDecimalExtractor but the whole of the input text must represent a number, not just
+ * Same as `toBigDecimalExtractor` but the whole of the input text must represent a number, not just
  * its start
  *
  * @category Parsing
  */
 export declare const toBigDecimalParser: (self: Type, fillChar?: string) => MTypes.OneArgFunction<string, Option.Option<BigDecimal.BigDecimal>>;
 /**
- * Same as toRealExtractor but the returned parser throws in case of error
+ * Same as `toBigDecimalParser` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
@@ -381,16 +381,16 @@ export declare const toThrowingBigDecimalParser: (self: Type, fillChar?: string)
  */
 export declare const toRealParser: (self: Type, fillChar?: string) => MTypes.OneArgFunction<string, Option.Option<CVReal.Type>>;
 /**
- * Same as toRealParser but the returned parser throws in case of error
+ * Same as `toRealParser` but the returned parser throws in case of failure
  *
  * @category Parsing
  */
 export declare const toThrowingRealParser: (self: Type, fillChar?: string) => (text: string) => CVReal.Type;
 /**
  * Returns a function that tries to format a `number` respecting the options represented by
- * `self`and an optional parameter `fillChars`. If successful, that function returns a `some` of the
- * formatted number. Otherwise, it returns a `none`. `number` can be of type number or BigDecimal
- * for better accuracy. There is a difference between number and BigDecimal (and bigint) regarding
+ * `self`and an optional parameter `fillChars`. If successful, that function returns a `Some` of the
+ * formatted number. Otherwise, it returns a `None`. `number` can be of type number or `BigDecimal`
+ * for better accuracy. There is a difference between number and `BigDecimal` (and bigint) regarding
  * the sign of 0. In Javascript, Object.is(0,-0) is false whereas Object.is(0n,-0n) is true. So if
  * the sign of zero is important to you, prefer passing a number to the function. `0` as a
  * BigDecimal will always be interpreted as a positive `0` as we have no means of knowing if it is
@@ -405,166 +405,166 @@ export declare const toThrowingRealParser: (self: Type, fillChar?: string) => (t
  */
 export declare const toNumberFormatter: (self: Type, fillChars?: string) => MTypes.OneArgFunction<BigDecimal.BigDecimal | CVReal.Type, string>;
 /**
- * Combinator that returns a copy of self with `minimumFractionalDigits` and
- * `maximumFractionalDigits` set to `n`. `n` must be a finite positive integer.
+ * Returns a copy of `self` with `minimumFractionalDigits` and `maximumFractionalDigits` set to `n`.
+ * `n` must be a finite positive integer
  *
  * @category Modifiers
  */
 export declare const withNDecimals: (decimalNumber: number) => MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `maximumFractionalDigits` set to `n`. `n` must be a
- * positive integer. Pass 0 for an integer format.
+ * Returns a copy of `self` with `maximumFractionalDigits` set to `n`. `n` must be a positive
+ * integer (`+Infinity` allowed). Pass 0 for an integer format
  *
  * @category Modifiers
  */
 export declare const withMaxNDecimals: (maxDecimalNumber: number) => (self: Type) => Type;
 /**
- * Combinator that returns a copy of self with `minimumFractionalDigits` set to `n`. `n` must be a
- * finite positive integer.
+ * Returns a copy of `self` with `minimumFractionalDigits` set to `n`. `n` must be a finite positive
+ * integer
  *
  * @category Modifiers
  */
 export declare const withMinNDecimals: (minDecimalNumber: number) => (self: Type) => Type;
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `None`.
+ * Returns a copy of `self` with `scientificNotation` set to `None`
  *
  * @category Modifiers
  */
 export declare const withNoScientificNotation: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `Standard`.
+ * Returns a copy of `self` with `scientificNotation` set to `Standard`
  *
  * @category Modifiers
  */
 export declare const withStandardScientificNotation: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `Normalized`.
+ * Returns a copy of `self` with `scientificNotation` set to `Normalized`
  *
  * @category Modifiers
  */
 export declare const withNormalizedScientificNotation: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `scientificNotation` set to `Engineering`.
+ * Returns a copy of `self` with `scientificNotation` set to `Engineering`
  *
  * @category Modifiers
  */
 export declare const withEngineeringScientificNotation: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `thousandSeparator` set to `thousandSeparator`.
+ * Returns a copy of `self` with `thousandSeparator` set to `thousandSeparator`
  *
  * @category Modifiers
  */
 export declare const withThousandSeparator: (thousandSeparator: string) => MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `thousandSeparator` set to ''.
+ * Returns a copy of `self` with `thousandSeparator` set to ''
  *
  * @category Modifiers
  */
 export declare const withoutThousandSeparator: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `fractionalSeparator` set to `fractionalSeparator`.
+ * Returns a copy of `self` with `fractionalSeparator` set to `fractionalSeparator`
  *
  * @category Modifiers
  */
 export declare const withFractionalSeparator: (fractionalSeparator: string) => MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Auto`.
+ * Returns a copy of `self` with `signDisplay` set to `Auto`
  *
  * @category Modifiers
  */
 export declare const withSignDisplayForNegative: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Always`.
+ * Returns a copy of `self` with `signDisplay` set to `Always`
  *
  * @category Modifiers
  */
 export declare const withSignDisplay: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `ExceptZero`.
+ * Returns a copy of `self` with `signDisplay` set to `ExceptZero`
  *
  * @category Modifiers
  */
 export declare const withSignDisplayExceptZero: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Negative`.
+ * Returns a copy of `self` with `signDisplay` set to `Negative`
  *
  * @category Modifiers
  */
 export declare const withSignDisplayForNegativeExceptZero: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `signDisplay` set to `Never`.
+ * Returns a copy of `self` with `signDisplay` set to `Never`
  *
  * @category Modifiers
  */
 export declare const withoutSignDisplay: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Ceil`.
+ * Returns a copy of `self` with `roundingMode` set to `Ceil`
  *
  * @category Modifiers
  */
 export declare const withCeilRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Floor`.
+ * Returns a copy of `self` with `roundingMode` set to `Floor`
  *
  * @category Modifiers
  */
 export declare const withFloorRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Expand`.
+ * Returns a copy of `self` with `roundingMode` set to `Expand`
  *
  * @category Modifiers
  */
 export declare const withExpandRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `Trunc`.
+ * Returns a copy of `self` with `roundingMode` set to `Trunc`
  *
  * @category Modifiers
  */
 export declare const withTruncRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfCeil`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfCeil`
  *
  * @category Modifiers
  */
 export declare const withHalfCeilRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfFloor`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfFloor`
  *
  * @category Modifiers
  */
 export declare const withHalfFloorRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfExpand`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfExpand`
  *
  * @category Modifiers
  */
 export declare const withHalfExpandRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfTrunc`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfTrunc`
  *
  * @category Modifiers
  */
 export declare const withHalfTruncRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `roundingMode` set to `HalfEven`.
+ * Returns a copy of `self` with `roundingMode` set to `HalfEven`
  *
  * @category Modifiers
  */
 export declare const withHalfEvenRoundingMode: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `showNullIntegerPart` set to `false`.
+ * Returns a copy of `self` with `showNullIntegerPart` set to `false`
  *
  * @category Modifiers
  */
 export declare const withNullIntegerPartNotShowing: MTypes.OneArgFunction<Type>;
 /**
- * Combinator that returns a copy of self with `showNullIntegerPart` set to `true`.
+ * Returns a copy of `self` with `showNullIntegerPart` set to `true`
  *
  * @category Modifiers
  */
 export declare const withNullIntegerPartShowing: MTypes.OneArgFunction<Type>;
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, a space as thousand
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, a space as thousand
  * separator and shows at most three fractional digits. Used in countries like France,
  * French-speaking Canada, French-speaking Belgium, Denmark, Finland, Sweden...
  *
@@ -572,22 +572,22 @@ export declare const withNullIntegerPartShowing: MTypes.OneArgFunction<Type>;
  */
 export declare const frenchStyleNumber: Type;
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, no thousand separator and
- * shows at most three fractional digits. Used in countries like France, French-speaking Canada,
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, no thousand separator
+ * and shows at most three fractional digits. Used in countries like France, French-speaking Canada,
  * French-speaking Belgium, Denmark, Finland, Sweden...
  *
  * @category Instances
  */
 export declare const frenchStyleUngroupedNumber: Type;
 /**
- * French-style integer NumberBase10Format instance. Used in countries like France, French-speaking
- * Canada, French-speaking Belgium, Denmark, Finland, Sweden...
+ * French-style integer `CVNumberBase10Format` instance. Used in countries like France,
+ * French-speaking Canada, French-speaking Belgium, Denmark, Finland, Sweden...
  *
  * @category Instances
  */
 export declare const frenchStyleInteger: Type;
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, a dot as thousand
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, a dot as thousand
  * separator and shows at most three fractional digits. Used in countries like Dutch-speaking
  * Belgium, the Netherlands, Germany, Italy, Norway, Croatia, Spain...
  *
@@ -595,22 +595,22 @@ export declare const frenchStyleInteger: Type;
  */
 export declare const dutchStyleNumber: Type;
 /**
- * NumberBase10Format instance that uses a comma as fractional separator, no thousand separator and
- * shows at most three fractional digits. Used in countries like Dutch-speaking Belgium, the
+ * `CVNumberBase10Format` instance that uses a comma as fractional separator, no thousand separator
+ * and shows at most three fractional digits. Used in countries like Dutch-speaking Belgium, the
  * Netherlands, Germany, Italy, Norway, Croatia, Spain...
  *
  * @category Instances
  */
 export declare const dutchStyleUngroupedNumber: Type;
 /**
- * Dutch-style integer NumberBase10Format instance. Used in countries like Dutch-speaking Belgium,
- * the Netherlands, Germany, Italy, Norway, Croatia, Spain...
+ * Dutch-style integer `CVNumberBase10Format` instance. Used in countries like Dutch-speaking
+ * Belgium, the Netherlands, Germany, Italy, Norway, Croatia, Spain...
  *
  * @category Instances
  */
 export declare const dutchStyleInteger: Type;
 /**
- * NumberBase10Format instance that uses a dot as fractional separator, a comma as thousand
+ * `CVNumberBase10Format` instance that uses a dot as fractional separator, a comma as thousand
  * separator and shows at most three fractional digits. Used in countries like the UK, the US,
  * English-speaking Canada, Australia, Thaïland, Bosnia...
  *
@@ -618,22 +618,22 @@ export declare const dutchStyleInteger: Type;
  */
 export declare const ukStyleNumber: Type;
 /**
- * NumberBase10Format instance that uses a dot as fractional separator, no thousand separator and
- * shows at most three fractional digits. Used in countries like the UK, the US, English-speaking
- * Canada, Australia, Thaïland, Bosnia...
+ * `CVNumberBase10Format` instance that uses a dot as fractional separator, no thousand separator
+ * and shows at most three fractional digits. Used in countries like the UK, the US,
+ * English-speaking Canada, Australia, Thaïland, Bosnia...
  *
  * @category Instances
  */
 export declare const ukStyleUngroupedNumber: Type;
 /**
- * Uk-style integer NumberBase10Format instance. Used in countries like the UK, the US,
+ * Uk-style integer `CVNumberBase10Format` instance. Used in countries like the UK, the US,
  * English-speaking Canada, Australia, Thaïland, Bosnia...
  *
  * @category Instances
  */
 export declare const ukStyleInteger: Type;
 /**
- * Integer NumberBase10Format instance with no thousand separator
+ * Integer `CVNumberBase10Format` instance with no thousand separator
  *
  * @category Instances
  */

package/dts/PositiveInteger.d.ts

@@ -1,9 +1,12 @@
 /**
- * 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 { MTypes } from '@parischap/effect-lib';
-import { BigDecimal, Brand, Either, Option } from 'effect';
+import { BigDecimal, Brand, Either, Option, Schema } from 'effect';
 import * as CVInteger from './Integer.js';
 import * as CVPositive from './internal/Positive.js';
 import type * as CVPositiveReal from './PositiveReal.js';
@@ -17,145 +20,169 @@ export declare const moduleTag = "@parischap/conversions/PositiveInteger/";
 /**
  * Brand constructor. Should not be used directly
  *
- * @category Constructors
+ * @ignore
  */
 export declare const constructor: Brand.Brand.Constructor<number & Brand.Brand<typeof CVPositive._TypeId> & Brand.Brand<typeof CVReal.TypeId> & Brand.Brand<typeof import("./internal/Int.js")._TypeId>>;
 /**
- * Integer type
+ * `CVPositiveInteger` type
  *
  * @category Models
  */
 export type Type = Brand.Brand.FromConstructor<typeof constructor>;
 /**
- * Constructs a PositiveInteger from a number without any verifications
+ * Constructs a `CVPositiveInteger` from a number without any verifications
  *
  * @category Constructors
  */
 export declare const unsafeFromNumber: Brand.Brand.Constructor<number & Brand.Brand<typeof CVPositive._TypeId> & Brand.Brand<typeof CVReal.TypeId> & Brand.Brand<typeof import("./internal/Int.js")._TypeId>>;
 /**
- * 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 declare const fromNumberOption: MTypes.OneArgFunction<number, Option.Option<Type>>;
 /**
- * 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 declare const fromNumber: MTypes.OneArgFunction<number, Either.Either<Type, Brand.Brand.BrandErrors>>;
 /**
- * Constructs a PositiveInteger from a number or throws
+ * Constructs a `CVPositiveInteger` from a number if possible. Throws otherwise
  *
  * @category Constructors
  */
 export declare const fromNumberOrThrow: MTypes.OneArgFunction<number, Type>;
 /**
- * Constructs a PositiveInteger from a BigDecimal without any checks
+ * Constructs a `CVPositiveInteger` from a `BigDecimal` without any checks
  *
  * @category Constructors
  */
 export declare const unsafeFromBigDecimal: MTypes.OneArgFunction<BigDecimal.BigDecimal, Type>;
 /**
- * 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 declare const fromBigDecimalOption: MTypes.OneArgFunction<BigDecimal.BigDecimal, Option.Option<Type>>;
 /**
- * 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 declare const fromBigDecimal: MTypes.OneArgFunction<BigDecimal.BigDecimal, Either.Either<Type, Brand.Brand.BrandErrors>>;
 /**
- * Constructs a PositiveInteger from a BigDecimal or throws
+ * Constructs a `CVPositiveInteger` from a `BigDecimal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export declare const fromBigDecimalOrThrow: MTypes.OneArgFunction<BigDecimal.BigDecimal, Type>;
 /**
- * Constructs a PositiveInteger from a BigInt without any checks
+ * Constructs a `CVPositiveInteger` from a `BigInt` without any checks
  *
  * @category Constructors
  */
 export declare const unsafeFromBigInt: MTypes.OneArgFunction<bigint, Type>;
 /**
- * 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 declare const fromBigIntOption: MTypes.OneArgFunction<bigint, Option.Option<Type>>;
 /**
- * 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 declare const fromBigInt: MTypes.OneArgFunction<bigint, Either.Either<Type, Brand.Brand.BrandErrors>>;
 /**
- * Constructs a PositiveInteger from a BigInt or throws
+ * Constructs a `CVPositiveInteger` from a `BigInt` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export declare const fromBigIntOrThrow: MTypes.OneArgFunction<bigint, Type>;
 /**
- * Constructs a PositiveInteger from a Real without any checks
+ * Constructs a `CVPositiveInteger` from a `CVReal` without any checks
  *
  * @category Constructors
  */
 export declare const unsafeFromReal: MTypes.OneArgFunction<CVReal.Type, Type>;
 /**
- * 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 declare const fromRealOption: MTypes.OneArgFunction<CVReal.Type, Option.Option<Type>>;
 /**
- * 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 declare const fromReal: MTypes.OneArgFunction<CVReal.Type, Either.Either<Type, Brand.Brand.BrandErrors>>;
 /**
- * Constructs a PositiveInteger from a Real or throws
+ * Constructs a `CVPositiveInteger` from a `CVReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export declare const fromRealOrThrow: MTypes.OneArgFunction<CVReal.Type, Type>;
 /**
- * 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 declare const fromIntegerOption: MTypes.OneArgFunction<CVInteger.Type, Option.Option<Type>>;
 /**
- * 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 declare const fromInteger: MTypes.OneArgFunction<CVInteger.Type, Either.Either<Type, Brand.Brand.BrandErrors>>;
 /**
- * Constructs a PositiveInteger from an Integer or throws
+ * Constructs a `CVPositiveInteger` from a `CVInteger` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export declare const fromIntegerOrThrow: MTypes.OneArgFunction<CVInteger.Type, Type>;
 /**
- * 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 declare const fromPositiveRealOption: MTypes.OneArgFunction<CVPositiveReal.Type, Option.Option<Type>>;
 /**
- * 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 declare const fromPositiveReal: MTypes.OneArgFunction<CVPositiveReal.Type, Either.Either<Type, Brand.Brand.BrandErrors>>;
 /**
- * Constructs a PositiveInteger from a PositiveReal or throws
+ * Constructs a `CVPositiveInteger` from a `CVPositiveReal` if possible. Throws otherwise
  *
  * @category Constructors
  */
 export declare const fromPositiveRealOrThrow: MTypes.OneArgFunction<CVPositiveReal.Type, Type>;
+/**
+ * A `Schema` that transforms a number into a `CVPositiveInteger`
+ *
+ * @ignore
+ */
+export declare const SchemaFromNumber: Schema.Schema<Type, number>;
+/**
+ * A Schema that represents a `CVPositiveInteger`
+ *
+ * @ignore
+ */
+export declare const SchemaFromSelf: Schema.Schema<Type>;
 //# sourceMappingURL=PositiveInteger.d.ts.map

package/dts/PositiveInteger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PositiveInteger.d.ts","sourceRoot":"","sources":["../../esm/PositiveInteger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAkB,MAAM,EAAU,MAAM,QAAQ,CAAC;AACnF,OAAO,KAAK,SAAS,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,SAAS,4CAA4C,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,WAAW,wKAA2D,CAAC;AAEpF;;;;GAIG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,WAAW,CAAC,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,wKAAwB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CACnD,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CACoB,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,cAAc,CAC7C,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACL,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAe,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAC5C,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,cAAc,CACvD,UAAU,CAAC,UAAU,EACrB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAC0E,CAAC;AAE/F;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,cAAc,CACjD,UAAU,CAAC,UAAU,EACrB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACqC,CAAC;AAEnF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAG3E,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAC7B,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAGtE,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,cAAc,CAC7C,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACiC,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAGxD,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAA8B,CAAC;AAEnG;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAGzE,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,cAAc,CAC3C,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAC+B,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAG3D,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAE/E,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,cAAc,CAC9C,SAAS,CAAC,IAAI,EACd,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACX,CAAC;AAEnC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAEjE,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,cAAc,CACzD,cAAc,CAAC,IAAI,EACnB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CACuB,CAAC;AAE5C;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CACnD,cAAc,CAAC,IAAI,EACnB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACd,CAAC;AAEhC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAE3E,CAAC"}
+{"version":3,"file":"PositiveInteger.d.ts","sourceRoot":"","sources":["../../esm/PositiveInteger.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAkB,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACnF,OAAO,KAAK,SAAS,MAAM,cAAc,CAAC;AAC1C,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,SAAS,4CAA4C,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,WAAW,wKAA2D,CAAC;AAEpF;;;;GAIG;AACH,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,WAAW,CAAC,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,wKAAwB,CAAC;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CACnD,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CACoB,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,cAAc,CAC7C,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACL,CAAC;AAEzC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAe,CAAC;AAElF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAC5C,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,cAAc,CACvD,UAAU,CAAC,UAAU,EACrB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAC0E,CAAC;AAE/F;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,cAAc,CACjD,UAAU,CAAC,UAAU,EACrB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACqC,CAAC;AAEnF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAG3E,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAC7B,CAAC;AAErC;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAGtE,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,cAAc,CAC7C,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACiC,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAGxD,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAA8B,CAAC;AAEnG;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAGzE,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,cAAc,CAC3C,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAC+B,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAG3D,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAE/E,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,cAAc,CAC9C,SAAS,CAAC,IAAI,EACd,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACX,CAAC;AAEnC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAEjE,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,cAAc,CACzD,cAAc,CAAC,IAAI,EACnB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CACuB,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,cAAc,CACnD,cAAc,CAAC,IAAI,EACnB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CACd,CAAC;AAEhC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAE3E,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAExD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAuC,CAAC"}