Skip to content

Commit f7fbeef

Browse files
committed
Fix doc for ensureXXXXX
1 parent 63d4425 commit f7fbeef

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ The `unknownutil` provides the following ensure functions which will raise
9595
`EnsureError` when a given `x` is not expected type.
9696

9797
- `ensureString(x: unknown): assert x is string`
98-
- `ensureNumber(x: unknown): assert x is string`
98+
- `ensureNumber(x: unknown): assert x is number`
9999
- `ensureBoolean(x: unknown): assert x is boolean`
100100
- `ensureArray<T extends unknown>(x: unknown, pred?: Predicate<T>): assert x is T[]`
101-
- `ensureObject<T extends unknown>(x: unknown, pred?: Predicate<T>): x ensure Record<string, T>`
102-
- `ensureFunction(x: unknown): x ensure (...args: unknown[]) => unknown`
103-
- `ensureNull(x: unknown): x ensure null`
104-
- `ensureUndefined(x: unknown): x ensure undefined`
105-
- `ensureNone(x: unknown): x ensure null | undefined`
101+
- `ensureObject<T extends unknown>(x: unknown, pred?: Predicate<T>): x is Record<string, T>`
102+
- `ensureFunction(x: unknown): x is (...args: unknown[]) => unknown`
103+
- `ensureNull(x: unknown): x is null`
104+
- `ensureUndefined(x: unknown): x is undefined`
105+
- `ensureNone(x: unknown): x is null | undefined`
106106

107107
For example:
108108

0 commit comments

Comments
 (0)