@@ -145,60 +145,60 @@ ensureLike({}, b); // Now 'b' is 'Record<string, unknown>'
145145ensureLike ({ foo: " " , bar: 0 }, b ); // Now 'b' is '{foo: string, bar: number}'
146146```
147147
148- ### requireXXXXX
148+ ### assumeXXXXX
149149
150- The ` unknownutil ` provides the following require functions which returns a given
150+ The ` unknownutil ` provides the following assume functions which returns a given
151151` x ` as is or raise ` EnsureError ` when that is not expected type.
152152
153- - ` requireString (x: unknown): string`
154- - ` requireNumber (x: unknown): number`
155- - ` requireBoolean (x: unknown): boolean`
156- - ` requireArray <T extends unknown>(x: unknown, pred?: Predicate<T>): T[]`
157- - ` requireObject <T extends unknown>(x: unknown, pred?: Predicate<T>): Record<string, T>`
158- - ` requireFunction (x: unknown): (...args: unknown[]) => unknown`
159- - ` requireNull (x: unknown): null`
160- - ` requireUndefined (x: unknown): undefined`
161- - ` requireNone (x: unknown): null | undefined`
153+ - ` assumeString (x: unknown): string`
154+ - ` assumeNumber (x: unknown): number`
155+ - ` assumeBoolean (x: unknown): boolean`
156+ - ` assumeArray <T extends unknown>(x: unknown, pred?: Predicate<T>): T[]`
157+ - ` assumeObject <T extends unknown>(x: unknown, pred?: Predicate<T>): Record<string, T>`
158+ - ` assumeFunction (x: unknown): (...args: unknown[]) => unknown`
159+ - ` assumeNull (x: unknown): null`
160+ - ` assumeUndefined (x: unknown): undefined`
161+ - ` assumeNone (x: unknown): null | undefined`
162162
163163For example:
164164
165165``` typescript
166- import { requireString } from " https://deno.land/x/unknownutil/mod.ts" ;
166+ import { assumeString } from " https://deno.land/x/unknownutil/mod.ts" ;
167167
168168const a: unknown = " Hello" ;
169- const a1 = requireString (a ); // Now 'a' and 'a1' is 'string'
169+ const a1 = assumeString (a ); // Now 'a' and 'a1' is 'string'
170170
171171const b: unknown = 0 ;
172- const b1 = requireString (b ); // Raise EnsureError on above while 'b' is not string
172+ const b1 = assumeString (b ); // Raise EnsureError on above while 'b' is not string
173173```
174174
175- Additionally, ` requireArray ` and ` requireObject ` supports an inner predicate
175+ Additionally, ` assumeArray ` and ` assumeObject ` supports an inner predicate
176176function to predicate ` x ` more precisely like:
177177
178178``` typescript
179- import { isString , requireArray } from " https://deno.land/x/unknownutil/mod.ts" ;
179+ import { assumeArray , isString } from " https://deno.land/x/unknownutil/mod.ts" ;
180180
181181const a: unknown = [" a" , " b" , " c" ];
182- const a1 = requireArray (a ); // Now 'a' and 'a1' is 'unknown[]'
183- const a2 = requireArray (a , isString ); // Now 'a' and 'a2' is 'string[]'
182+ const a1 = assumeArray (a ); // Now 'a' and 'a1' is 'unknown[]'
183+ const a2 = assumeArray (a , isString ); // Now 'a' and 'a2' is 'string[]'
184184
185185const b: unknown = [0 , 1 , 2 ];
186- const b1 = requireArray (b ); // Now 'b' and 'b1' is 'unknown[]'
187- const b2 = requireArray (b , isString ); // Raise EnsureError on above while 'b' is not string array
186+ const b1 = assumeArray (b ); // Now 'b' and 'b1' is 'unknown[]'
187+ const b2 = assumeArray (b , isString ); // Raise EnsureError on above while 'b' is not string array
188188```
189189
190- Use ` requireLike ` if you need some complicated types like tuple or struct like:
190+ Use ` assumeLike ` if you need some complicated types like tuple or struct like:
191191
192192``` typescript
193- import { requireLike } from " https://deno.land/x/unknownutil/mod.ts" ;
193+ import { assumeLike } from " https://deno.land/x/unknownutil/mod.ts" ;
194194
195195const a: unknown = [" a" , " b" , " c" ];
196- const a1 = requireLike ([], a ); // Now 'a' and 'a1' is 'unknown[]'
197- const a2 = requireLike ([" " , " " , " " ], a ); // Now 'a' and 'a2' is '[string, string, string]'
196+ const a1 = assumeLike ([], a ); // Now 'a' and 'a1' is 'unknown[]'
197+ const a2 = assumeLike ([" " , " " , " " ], a ); // Now 'a' and 'a2' is '[string, string, string]'
198198
199199const b: unknown = { foo: " foo" , bar: 0 };
200- const b1 = requireLike ({}, b ); // Now 'b' and 'b1' is 'Record<string, unknown>'
201- const b2 = requireLike ({ foo: " " , bar: 0 }, b ); // Now 'b' and 'b2' is '{foo: string, bar: number}'
200+ const b1 = assumeLike ({}, b ); // Now 'b' and 'b1' is 'Record<string, unknown>'
201+ const b2 = assumeLike ({ foo: " " , bar: 0 }, b ); // Now 'b' and 'b2' is '{foo: string, bar: number}'
202202```
203203
204204## Development
0 commit comments