moderndash 0.3.0 → 0.3.1

package/dist/index.d.ts

@@ -730,11 +730,13 @@ declare function unescapeHtml(str: string): string;
 /**
  * A `number` that is an integer.
  * 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
 */
 type Integer<T extends number> = `${T}` extends `${bigint}` ? T : never;
@@ -744,9 +746,10 @@ type Integer<T extends number> = `${T}` extends `${bigint}` ? T : never;
  * You can't pass a `bigint` as they are already guaranteed to be integers.
  * Use-case: Validating and documenting parameters.
  * @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
 */
@@ -754,32 +757,40 @@ type Float<T extends number> = T extends Integer<T> ? never : T;
 
 /**
  * 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>) {};
+ *
+ * setNegative(-1.2); // OK
+ * setNegative(1); // Error
  *
- * function setLength<T extends number>(length: Negative<Integer<T>>) {
- *   // ...
- *  };
+ * function setNegInt<T extends number>(x: Negative<Integer<T>>) {};
+ *
+ * setNegInt(-1); // OK
+ * setNegInt(1); // Error
+ * setNegInt(-1.1); // Error
  * @category type
 */
 type Negative<T extends number | bigint> = T extends 0 | 0n ? never : `${T}` extends `-${string}` ? T : never;
 
 /**
-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
 */
 type Positive<T extends number | bigint> = T extends 0 | 0n ? never : Negative<T> extends never ? T : never;
 

package/package.json

@@ -48,5 +48,5 @@
     "tsup": "6.5.0",
     "ctix": "1.8.1"
   },
-  "version": "0.3.0"
+  "version": "0.3.1"
 }