1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-01 09:24:20 -04:00
denoland-deno/std/node/util.ts
Evan Hahn f5c0188b5e
std/node: add util.callbackify (#5415)
This adds [Node's `util.callbackify`][0] to `std/node/util.ts`.

I lifted most of this from the [original Node source code][1] (and [its
tests][2]). I tried to make minimal modifications to the source.

I made a few arbitrary decisions:

- I was unable to do the function's types elegantly. I made overloads
  for functions that have 0 to 5 (inclusive) arguments, excluding the
  callback. I would love to know a better way to do this. (It seems that
  the folks at DefinitelyTyped [were also stumped][3], though maybe
  their solution is deliberate.)
- There are a few edge cases that cause custom Node errors to be
  produced. Instead of re-implementing those errors completely, I
  created simplified classes. These are mostly correct but are not
  identical to the real Node errors.
- The tests implement a possibly-arcane `TestQueue` class. I originally
  used a lot of inline promises but found it too repetitive.

Closes [#5366][4].

[0]: https://nodejs.org/api/util.html#util_util_callbackify_original
[1]: 4780493301/lib/util.js (L183-L226)
[2]: 4780493301/test/parallel/test-util-callbackify.js
[3]: 7d24857ddb/types/node/util.d.ts (L61-L84)
[4]: https://github.com/denoland/deno/issues/5366
2020-05-20 10:29:05 -04:00

72 lines
1.8 KiB
TypeScript

export { callbackify } from "./_util/_util_callbackify.ts";
export function isArray(value: unknown): boolean {
return Array.isArray(value);
}
export function isBoolean(value: unknown): boolean {
return typeof value === "boolean" || value instanceof Boolean;
}
export function isNull(value: unknown): boolean {
return value === null;
}
export function isNullOrUndefined(value: unknown): boolean {
return value === null || value === undefined;
}
export function isNumber(value: unknown): boolean {
return typeof value === "number" || value instanceof Number;
}
export function isString(value: unknown): boolean {
return typeof value === "string" || value instanceof String;
}
export function isSymbol(value: unknown): boolean {
return typeof value === "symbol";
}
export function isUndefined(value: unknown): boolean {
return value === undefined;
}
export function isObject(value: unknown): boolean {
return value !== null && typeof value === "object";
}
export function isError(e: unknown): boolean {
return e instanceof Error;
}
export function isFunction(value: unknown): boolean {
return typeof value === "function";
}
export function isRegExp(value: unknown): boolean {
return value instanceof RegExp;
}
export function isPrimitive(value: unknown): boolean {
return (
value === null || (typeof value !== "object" && typeof value !== "function")
);
}
export function validateIntegerRange(
value: number,
name: string,
min = -2147483648,
max = 2147483647
): void {
// The defaults for min and max correspond to the limits of 32-bit integers.
if (!Number.isInteger(value)) {
throw new Error(`${name} must be 'an integer' but was ${value}`);
}
if (value < min || value > max) {
throw new Error(
`${name} must be >= ${min} && <= ${max}. Value was ${value}`
);
}
}