Spaces:
Running
Running
File size: 7,059 Bytes
3c778ff | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | /* tslint:disable:ban-types */
import { values as objectValues } from 'src/utils/objects';
export const backtick = (val: any) => `\`${val}\``;
export const singleQuote = (val: any) => `'${val}'`;
type Primitive = string | number | boolean | undefined | null;
// prettier-ignore
const formatValue = (value: any) => {
const type = typeof value;
if (type ==='string') return singleQuote(value);
else if (type ==='undefined') return backtick(value);
else return value;
};
export const createValueErrorMsg = (
value: any,
valueName: string,
values: Primitive[],
) => {
const allowedValues = new Array(values.length);
for (let idx = 0, len = values.length; idx < len; idx++) {
const v = values[idx];
allowedValues[idx] = formatValue(v);
}
const joinedValues = allowedValues.join(' or ');
// prettier-ignore
return `${backtick(valueName)} must be one of ${joinedValues}, but was actually ${formatValue(value)}`;
};
export const assertIsOneOf = (
value: any,
valueName: string,
allowedValues: Primitive[] | { [key: string]: Primitive },
) => {
if (!Array.isArray(allowedValues)) {
allowedValues = objectValues(allowedValues);
}
for (let idx = 0, len = allowedValues.length; idx < len; idx++) {
if (value === allowedValues[idx]) return;
}
throw new TypeError(createValueErrorMsg(value, valueName, allowedValues));
};
export const assertIsOneOfOrUndefined = (
value: any,
valueName: string,
allowedValues: Primitive[] | { [key: string]: Primitive },
) => {
if (!Array.isArray(allowedValues)) {
allowedValues = objectValues(allowedValues);
}
assertIsOneOf(value, valueName, allowedValues.concat(undefined));
};
export const assertIsSubset = (
values: any[],
valueName: string,
allowedValues: Primitive[] | { [key: string]: Primitive },
) => {
if (!Array.isArray(allowedValues)) {
allowedValues = objectValues(allowedValues);
}
for (let idx = 0, len = values.length; idx < len; idx++) {
assertIsOneOf(values[idx], valueName, allowedValues);
}
};
export const getType = (val: any) => {
if (val === null) return 'null';
if (val === undefined) return 'undefined';
if (typeof val === 'string') return 'string';
if (isNaN(val)) return 'NaN';
if (typeof val === 'number') return 'number';
if (typeof val === 'boolean') return 'boolean';
if (typeof val === 'symbol') return 'symbol';
if (typeof val === 'bigint') return 'bigint';
if (val.constructor && val.constructor.name) return val.constructor.name;
if (val.name) return val.name;
if (val.constructor) return String(val.constructor);
return String(val);
};
export type TypeDescriptor =
| 'null'
| 'undefined'
| 'string'
| 'number'
| 'boolean'
| 'symbol'
| 'bigint'
| DateConstructor
| ArrayConstructor
| Uint8ArrayConstructor
| ArrayBufferConstructor
| FunctionConstructor
| [Function, string];
export const isType = (value: any, type: TypeDescriptor) => {
if (type === 'null') return value === null;
if (type === 'undefined') return value === undefined;
if (type === 'string') return typeof value === 'string';
if (type === 'number') return typeof value === 'number' && !isNaN(value);
if (type === 'boolean') return typeof value === 'boolean';
if (type === 'symbol') return typeof value === 'symbol';
if (type === 'bigint') return typeof value === 'bigint';
if (type === Date) return value instanceof Date;
if (type === Array) return value instanceof Array;
if (type === Uint8Array) return value instanceof Uint8Array;
if (type === ArrayBuffer) return value instanceof ArrayBuffer;
if (type === Function) return value instanceof Function;
return value instanceof (type as [Function, string])[0];
};
export const createTypeErrorMsg = (
value: any,
valueName: string,
types: TypeDescriptor[],
) => {
const allowedTypes = new Array(types.length);
for (let idx = 0, len = types.length; idx < len; idx++) {
const type = types[idx];
if (type === 'null') allowedTypes[idx] = backtick('null');
if (type === 'undefined') allowedTypes[idx] = backtick('undefined');
if (type === 'string') allowedTypes[idx] = backtick('string');
else if (type === 'number') allowedTypes[idx] = backtick('number');
else if (type === 'boolean') allowedTypes[idx] = backtick('boolean');
else if (type === 'symbol') allowedTypes[idx] = backtick('symbol');
else if (type === 'bigint') allowedTypes[idx] = backtick('bigint');
else if (type === Array) allowedTypes[idx] = backtick('Array');
else if (type === Uint8Array) allowedTypes[idx] = backtick('Uint8Array');
else if (type === ArrayBuffer) allowedTypes[idx] = backtick('ArrayBuffer');
else allowedTypes[idx] = backtick((type as [Function, string])[1]);
}
const joinedTypes = allowedTypes.join(' or ');
// prettier-ignore
return `${backtick(valueName)} must be of type ${joinedTypes}, but was actually of type ${backtick(getType(value))}`;
};
export const assertIs = (
value: any,
valueName: string,
types: TypeDescriptor[],
) => {
for (let idx = 0, len = types.length; idx < len; idx++) {
if (isType(value, types[idx])) return;
}
throw new TypeError(createTypeErrorMsg(value, valueName, types));
};
export const assertOrUndefined = (
value: any,
valueName: string,
types: TypeDescriptor[],
) => {
assertIs(value, valueName, types.concat('undefined'));
};
export const assertEachIs = (
values: any[],
valueName: string,
types: TypeDescriptor[],
) => {
for (let idx = 0, len = values.length; idx < len; idx++) {
assertIs(values[idx], valueName, types);
}
};
export const assertRange = (
value: any,
valueName: string,
min: number,
max: number,
) => {
assertIs(value, valueName, ['number']);
assertIs(min, 'min', ['number']);
assertIs(max, 'max', ['number']);
max = Math.max(min, max);
if (value < min || value > max) {
// prettier-ignore
throw new Error(`${backtick(valueName)} must be at least ${min} and at most ${max}, but was actually ${value}`);
}
};
export const assertRangeOrUndefined = (
value: any,
valueName: string,
min: number,
max: number,
) => {
assertIs(value, valueName, ['number', 'undefined']);
if (typeof value === 'number') assertRange(value, valueName, min, max);
};
export const assertMultiple = (
value: any,
valueName: string,
multiplier: number,
) => {
assertIs(value, valueName, ['number']);
if (value % multiplier !== 0) {
// prettier-ignore
throw new Error(`${backtick(valueName)} must be a multiple of ${multiplier}, but was actually ${value}`);
}
};
export const assertInteger = (value: any, valueName: string) => {
if (!Number.isInteger(value)) {
throw new Error(
`${backtick(valueName)} must be an integer, but was actually ${value}`,
);
}
};
export const assertPositive = (value: number, valueName: string) => {
if (![1, 0].includes(Math.sign(value))) {
// prettier-ignore
throw new Error(`${backtick(valueName)} must be a positive number or 0, but was actually ${value}`);
}
};
|