moderndash - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

dist/index.d.ts

@@ -733,7 +733,9 @@ /**
  * You can't pass a `bigint` as they are already guaranteed to be integers.
+ *
  * Use-case: Validating and documenting parameters.
  * @example
- * function setYear<T extends number>(length: Integer<T>) {
- *  // ...
- * };
+ * function setYear<T extends number>(x: Integer<T>){};
+ *
+ * setYear(1); // OK
+ * setYear(1.1); // Error
  * @category type
@@ -748,6 +750,7 @@ */
  * @example
- * function setPercentage<T extends number>(length: Float<T>) {
- *   // ...
- * };
+ * function setPercentage<T extends number>(length: Float<T>) {};
  *
+ * setPercentage(1.1); // OK
+ * setPercentage(1); // Error
+ *
  * @category type
@@ -759,11 +762,15 @@ */
  * A negative `number`/`bigint` (`-∞ < x < 0`)
+ *
  * Use-case: Validating and documenting parameters.
  * @example
- * function setLength<T extends number>(length: Negative<T>) {
- *    // ...
- *  };
+ * function setNegative<T extends number>(x: Negative<T>) {};
  *
- * function setLength<T extends number>(length: Negative<Integer<T>>) {
- *   // ...
- *  };
+ * setNegative(-1.2); // OK
+ * setNegative(1); // Error
+ *
+ * function setNegInt<T extends number>(x: Negative<Integer<T>>) {};
+ *
+ * setNegInt(-1); // OK
+ * setNegInt(1); // Error
+ * setNegInt(-1.1); // Error
  * @category type
@@ -774,14 +781,18 @@ */
 /**
-A positive `number`/`bigint` (`0 < x < ∞`).
-Use-case: Validating and documenting parameters.
-@example
-function setLength<T extends number>(length: Positive<T>) {
-    // ...
-};
-
-function setLength<T extends number>(length: Positive<Integer<T>>) {
-    // ...
-};
-
-@category type
+ * A positive `number`/`bigint` (`0 < x < ∞`).
+ *
+ * Use-case: Validating and documenting parameters.
+ * @example
+ * function setPositive<T extends number>(x: Positive<T>) {};
+ *
+ * setPositive(1.2); // OK
+ * setPositive(-1); // Error
+ *
+ * function setPosInt<T extends number>(x: Positive<Integer<T>>) {};
+ *
+ * setPosInt(1); // OK
+ * setPosInt(-1); // Error
+ * setPosInt(1.1); // Error
+ *
+ * @category type
 */
@@ -788,0 +799,0 @@ type Positive<T extends number | bigint> = T extends 0 | 0n ? never : Negative<T> extends never ? T : never;

package.json

@@ -51,3 +51,3 @@ {
   },
-  "version": "0.3.0"
+  "version": "0.3.1"
 }

No alert changes

Improved metrics

Total package byte prevSize

179579

increased by0.17%

Lines of code

2066

increased by0.63%

No dependency changes