Skip to content

Commit aa3b40e

Browse files
committed
Remove ensure and assume functions
Uses must replace `ensure` or `assume` functions to corresponding specific functions like `ensureString` or `assumeNumber`, etc.
1 parent d73006d commit aa3b40e

File tree

5 files changed

+1
-39
lines changed

5 files changed

+1
-39
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ if (isLike({ foo: "", bar: 0 }, e)) {
9494
The `unknownutil` provides the following ensure functions which will raise
9595
`EnsureError` when a given `x` is not expected type.
9696

97-
- `ensure<T>(x: unknown, pred: Predicate<T>, message?: string): assert x is T`
9897
- `ensureString(x: unknown): assert x is string`
9998
- `ensureNumber(x: unknown): assert x is number`
10099
- `ensureBoolean(x: unknown): assert x is boolean`
@@ -151,7 +150,6 @@ ensureLike({ foo: "", bar: 0 }, b); // Now 'b' is '{foo: string, bar: number}'
151150
The `unknownutil` provides the following assume functions which returns a given
152151
`x` as is or raise `EnsureError` when that is not expected type.
153152

154-
- `assume<T>(x: unknown, pred: Predicate<T>, message?: string): T`
155153
- `assumeString(x: unknown): string`
156154
- `assumeNumber(x: unknown): number`
157155
- `assumeBoolean(x: unknown): boolean`

assume.ts

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import { Predicate } from "./is.ts";
22
import {
3-
ensure,
43
ensureArray,
54
ensureBoolean,
65
ensureFunction,
@@ -13,18 +12,6 @@ import {
1312
ensureUndefined,
1413
} from "./ensure.ts";
1514

16-
/**
17-
* Return `x` as-is if `x` is expected type or raise an `EnsureError` when it's not.
18-
*/
19-
export function assume<T>(
20-
x: unknown,
21-
pred: Predicate<T>,
22-
message = "The value is not expected type",
23-
): T {
24-
ensure(x, pred, message);
25-
return x;
26-
}
27-
2815
/**
2916
* Return `x` as-is if `x` is string or raise an `EnsureError` when it's not.
3017
*/

assume_test.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import { assertEquals, assertThrows } from "./deps_test.ts";
22
import {
3-
assume,
43
assumeArray,
54
assumeBoolean,
65
assumeFunction,
@@ -14,15 +13,6 @@ import {
1413
} from "./assume.ts";
1514
import { isBoolean, isNumber, isString } from "./is.ts";
1615

17-
Deno.test("assume returns the value when pred return true", () => {
18-
assertEquals(assume("a", isString), "a");
19-
assertEquals(assume(0, isNumber), 0);
20-
});
21-
Deno.test("assume throws error when pred return false", () => {
22-
assertThrows(() => assume("a", isNumber));
23-
assertThrows(() => assume(0, isString));
24-
});
25-
2616
Deno.test("assumeString returns the value when the value is string", () => {
2717
assertEquals(assumeString("Hello"), "Hello");
2818
});

ensure.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@ export class EnsureError extends Error {
2424
}
2525
}
2626

27-
/**
28-
* Ensure if `x` is expected type by raising an `EnsureError` when it's not.
29-
*/
30-
export function ensure<T>(
27+
function ensure<T>(
3128
x: unknown,
3229
pred: Predicate<T>,
3330
message = "The value is not expected type",

ensure_test.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import { assertThrows } from "./deps_test.ts";
22
import {
3-
ensure,
43
ensureArray,
54
ensureBoolean,
65
ensureFunction,
@@ -14,15 +13,6 @@ import {
1413
} from "./ensure.ts";
1514
import { isBoolean, isNumber, isString } from "./is.ts";
1615

17-
Deno.test("ensure does nothing when pred return true", () => {
18-
ensure("a", isString);
19-
ensure(0, isNumber);
20-
});
21-
Deno.test("ensure throws error when pred return false", () => {
22-
assertThrows(() => ensure("a", isNumber));
23-
assertThrows(() => ensure(0, isString));
24-
});
25-
2616
Deno.test("ensureString does nothing on string", () => {
2717
ensureString("Hello");
2818
});

0 commit comments

Comments
 (0)