Skip to content

Commit f18995b

Browse files
committed
chore: minor cleanup in JSDoc codeblocks
1 parent 157ebd9 commit f18995b

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

source/greater-than-or-equal.d.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,14 @@ import type {GreaterThanOrEqual} from 'type-fest';
4040
// Use `GreaterThanOrEqual` to constrain a function parameter to non-negative numbers.
4141
declare function setNonNegative<N extends number>(value: GreaterThanOrEqual<N, 0> extends true ? N : never): void;
4242
43-
setNonNegative(0);
44-
setNonNegative(1);
43+
setNonNegative(0); // ✅ Allowed
44+
setNonNegative(1); // ✅ Allowed
4545
4646
// @ts-expect-error
4747
setNonNegative(-1);
48+
49+
// @ts-expect-error
50+
setNonNegative(-2);
4851
```
4952
*/
5053
export type GreaterThanOrEqual<A extends number, B extends number> = number extends A | B

source/greater-than.d.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,14 @@ import type {GreaterThan} from 'type-fest';
4444
// Use `GreaterThan` to constrain a function parameter to positive numbers.
4545
declare function setPositive<N extends number>(value: GreaterThan<N, 0> extends true ? N : never): void;
4646
47-
setPositive(1);
47+
setPositive(1); // ✅ Allowed
48+
setPositive(2); // ✅ Allowed
4849
4950
// @ts-expect-error
50-
setPositive(-1);
51+
setPositive(0);
5152
5253
// @ts-expect-error
53-
setPositive(0);
54+
setPositive(-1);
5455
```
5556
*/
5657
export type GreaterThan<A extends number, B extends number> =

source/less-than-or-equal.d.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,14 @@ import type {LessThanOrEqual} from 'type-fest';
4040
// Use `LessThanOrEqual` to constrain a function parameter to non-positive numbers.
4141
declare function setNonPositive<N extends number>(value: LessThanOrEqual<N, 0> extends true ? N : never): void;
4242
43-
setNonPositive(-1);
44-
setNonPositive(0);
43+
setNonPositive(0); // ✅ Allowed
44+
setNonPositive(-1); // ✅ Allowed
4545
4646
// @ts-expect-error
4747
setNonPositive(1);
48+
49+
// @ts-expect-error
50+
setNonPositive(2);
4851
```
4952
*/
5053
export type LessThanOrEqual<A extends number, B extends number> =

source/less-than.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ import type {LessThan} from 'type-fest';
4040
// Use `LessThan` to constrain a function parameter to negative numbers.
4141
declare function setNegative<N extends number>(value: LessThan<N, 0> extends true ? N : never): void;
4242
43-
setNegative(-1);
43+
setNegative(-1); // ✅ Allowed
44+
setNegative(-2); // ✅ Allowed
4445
4546
// @ts-expect-error
4647
setNegative(0);

0 commit comments

Comments
 (0)