inferred-types 0.51.1 → 0.51.2

package/src/runtime/type-guards/isContainer.ts

@@ -1,20 +0,0 @@
-import {  Dictionary,  IsObject } from "inferred-types/dist/types/index";
-import { isObject } from "src/runtime/index";
-
-type ContainerType<T> = T extends any[]
-? any[]
-: IsObject<T> extends true
-  ? Dictionary
-  : T extends Map<any,any>
-  ? Map<any,any>
-  : T extends Set<any>
-  ? Set<any>
-  : T extends WeakMap<any,any>
-  ? WeakMap<any,any>
-  : object;
-
-export function isContainer<T>(value: T): value is T & ContainerType<T> {
-  return Array.isArray(value) || isObject(value)
-    ? true
-    : false;
-}

package/src/runtime/type-guards/isCssAspectRatio.ts

@@ -1,16 +0,0 @@
-import { CssAspectRatio } from "inferred-types/dist/types/index";
-import { isString } from "./isString";
-
-const tokens = [
-  "1", "inherit", "initial", "revert", "revert-layer", "unset", "auto"
-]
-
-const isRatio = (val: string) => /[0-9]{1,4}\s*\/\s*[0-9]{1,4}/.test(val)
-
-/**
- * Type guard which tests whether the passed in value is a valid CSS Aspect
- * Ratio value.
- */
-export const isCssAspectRatio = <T>(val: T): val is T & CssAspectRatio => {
-  return isString(val) && val.split(/\s+/).every(i => tokens.includes(i) || isRatio(i))
-}

package/src/runtime/type-guards/isDefined.ts

@@ -1,9 +0,0 @@
-/**
- * **isDefined**(value)
- * 
- * Type guard which determines whether a type is _defined_ or not 
- * (aka, whether the value is **not** _undefined_).
- */
-export function isDefined<T>(value: T): value is Exclude<T,undefined> {
-  return (typeof value === "undefined") ? false : true;
-}

package/src/runtime/type-guards/isDoneFn.ts

@@ -1,14 +0,0 @@
-import { AsDoneFn } from "inferred-types/dist/types/index"
-import { hasKeys } from "src/runtime/index"
-
-/**
- * **isDoneFn**(val)
- *
- * A type guard which checks whether the value passed in has a `done`
- * property which is a function.
- */
-export const isDoneFn = <T>(val: T): val is AsDoneFn<T> => {
-
-
-  return hasKeys("done")(val) && typeof (val as any).done === "function"
-}

package/src/runtime/type-guards/isEmail.ts

@@ -1,31 +0,0 @@
-import { Email } from "inferred-types/dist/types/index"
-import { isString } from "src/runtime/index";
-import { LOWER_ALPHA_CHARS } from "inferred-types/dist/constants/index";
-
-/**
- * **isEmail**`(val)`
- *
- * type guard which validates that the value passed in
- * in the correct shape to be an email address. It checks:
- *
- * 1. that leads with alphabetic char
- * 2. has a `@` character
- * 3. has at least one `.` char after the `@`
- * 4. top-level domain has at least 2 characters
- */
-export const isEmail = (val: unknown): val is Email => {
-  if (!isString(val)) {
-    return false
-  }
-  const parts: string[] = val?.split("@");
-  const domain = parts[1]?.split(".");
-  const tld = domain ? domain.pop() as string : "";
-  const firstChar = val[0].toLowerCase();
-
-  return isString(val) && (
-    LOWER_ALPHA_CHARS.includes(firstChar as any) &&
-    parts.length === 2 &&
-    domain.length >= 1 &&
-    tld.length >= 2
-  )
-}

package/src/runtime/type-guards/isErrorCondition.ts

@@ -1,19 +0,0 @@
-import { ErrorCondition } from "inferred-types/dist/types/index";
-import { isObject } from "src/runtime/index";
-
-
-/**
- * **isErrorCondition**(value)
- *
- * Type guard which checks whether the given value is a `ErrorCondition` type.
- */
-export function isErrorCondition<
-  TKind extends string | null,
-  T extends ErrorCondition<TKind extends null ? string : TKind>
->(value: unknown | T, kind: TKind = null as TKind): value is T {
-  return isObject(value) && "__kind" in value && value.__kind === "ErrorCondition" && "kind" in value
-    ? kind !== null
-      ? value["kind"] === kind
-      : true
-    : false;
-}

package/src/runtime/type-guards/isFalse.ts

@@ -1,3 +0,0 @@
-export function isFalse(i: unknown): i is false {
-  return (typeof i === "boolean" && !i);
-}

package/src/runtime/type-guards/isFalsy.ts

@@ -1,14 +0,0 @@
-
-import { FalsyValue, Narrowable } from "inferred-types/dist/types/index";
-import { FALSY_VALUES } from "inferred-types/dist/constants/index";
-
-/**
- * **isFalsy**()
- *
- * Creates a TypeGuard which checks whether a value is considered _falsy_ in
- * Javascript.
- */
-export const isFalsy = <V extends Narrowable>(val: V): val is V & FalsyValue => {
-  return FALSY_VALUES.includes(val as any);
-};
-

package/src/runtime/type-guards/isFnWithParams.ts

@@ -1,11 +0,0 @@
-import { Scalar , ToFn } from "inferred-types/dist/types/index";
-
-/**
- * **isFnWithDict**(input)
- *
- * Type guard which checks whether a give variable is a function
- * which _also_ contains
- */
-export function isFnWithParams<T>(input: T): input is Exclude<T, Scalar | undefined> & ToFn<Exclude<T, Scalar | undefined>> {
-  return typeof input === "function" && Object.keys(input)?.length > 0;
-}

package/src/runtime/type-guards/isFunction.ts

@@ -1,15 +0,0 @@
-import {  TypedFunction } from "inferred-types/dist/types/index";
-
-/**
- * **isFunction**(value)
- *
- * Type guard which checks whether the passed in value is a function.
- *
- * **Related:** `isFnWithParams`, `ifFunction`
- */
-export function isFunction<T>(value: T): value is T & TypedFunction {
-  return (typeof value === "function"
-    ? true
-    : false
-  );
-}

package/src/runtime/type-guards/isHexadecimal.ts

@@ -1,15 +0,0 @@
-import { asChars } from "../type-conversion/asChars"
-import { isNumericString } from "./isNumericString"
-import { isString } from "./isString"
-
-
-/**
- * **isHexadecimal**`(val)`
- *
- * Type guard which checks whether all of the characters in the given string
- * are hexadecimal characters.
- */
-export const isHexadecimal = <T>(val: T): val is T => {
-  return isString(val) &&
-    asChars(val).every(i => isNumericString(i) || ["a","b","c","d","e","f"].includes(i.toLowerCase()))
-}

package/src/runtime/type-guards/isIndexable.ts

@@ -1,14 +0,0 @@
-import { AnyObject, Indexable } from "inferred-types/dist/types/index";
-import { keysOf } from "src/runtime/index";
-
-
-/**
- * **isIndexable**(value)
- *
- * Type guard which validates that the value passed in can be _indexed_
- */
-export function isIndexable<T>(value: T): value is T & Indexable {
-  return Array.isArray(value) || (typeof value === "object" && keysOf(value as AnyObject).length > 0)
-    ? true
-    : false;
-}

package/src/runtime/type-guards/isInlineSvg.ts

@@ -1,12 +0,0 @@
-import { InlineSvg } from "inferred-types/dist/types/index";
-import { isString } from "./isString"
-
-/**
- * **isInlineSvg**`(val)`
- *
- * Type guard which tests whether the passed in value is both a string
- * and also appears to be an inline SVG image.
- */
-export const isInlineSvg = <T>(v: T): v is T & InlineSvg => {
-  return isString(v) && v.trim().startsWith(`<svg`) && v.trim().endsWith(`</svg>`);
-}

package/src/runtime/type-guards/isLeftRight.ts

@@ -1,16 +0,0 @@
-import { LeftRight, Narrowable, Tuple } from "inferred-types/dist/types/index";
-import { isArray } from "src/runtime/index";
-
-
-/**
- * **isLeftRight**(value)
- *
- * Type guard for detecting a `LeftRight` result.
- */
-export const isLeftRight = <T extends Narrowable | Tuple>(
-  value: T
-): value is T & LeftRight<unknown, unknown> => {
-
-  return isArray(value) && (value as any).length === 3 && value[0] === "LeftRight";
-};
-

package/src/runtime/type-guards/isNever.ts

@@ -1,12 +0,0 @@
-import { isConstant } from "src/runtime/index"
-
-
-/**
- * **isNever**(val)
- * 
- * Type guard which checks for the runtime constant `Never`
- * (which also has a _type_ of **never**).
- */
-export const isNever = (val: unknown): val is never => {
-  return isConstant(val) && val.kind === "never";
-}

package/src/runtime/type-guards/isNotNull.ts

@@ -1,10 +0,0 @@
-import { NotNull } from "inferred-types/dist/types/index";
-
-/**
- * **isNotNull**(value)
- *
- * Type guard which validates the passed in value is **not** the `null` value.
- */
-export function isNotNull<T>(value: T): value is T & NotNull {
-  return (value === null) ? true : false;
-}

package/src/runtime/type-guards/isNothing.ts

@@ -1,5 +0,0 @@
-import { Nothing } from "inferred-types/dist/types/index";
-
-export function isNothing<T>(val: T): val is T & Nothing {
-  return val === null || val === undefined ? true : false;
-}

package/src/runtime/type-guards/isNull.ts

@@ -1,11 +0,0 @@
-
-/**
- * **isNull**(value)
- * 
- * Type guard which checks whether a value is null or not.
- * 
- * **Related:** `ifNull`
- */
-export function isNull<T>(value: T): value is T & null {
-  return (value === null) ? true : false;
-}

package/src/runtime/type-guards/isNumber.ts

@@ -1,9 +0,0 @@
-
-/**
- * **isNumber**(value)
- * 
- * Type guard to test whether passed in value is a numeric type.
- */
-export function isNumber<T>(value: T): value is T & number {
-  return (typeof value === "number");
-}

package/src/runtime/type-guards/isNumericString.ts

@@ -1,41 +0,0 @@
-import { NUMERIC_CHAR } from "inferred-types/dist/constants/index";
-import { split } from "../literals/split";
-import { NumberLike } from "inferred-types/dist/types/index";
-
-
-/**
- * **isNumericString**(value)
- *
- * Type guard to validate that a value is string which can be converted to a number.
- *
- * **Related:** `isNumberLike`
- */
-export function isNumericString<T>(value: T): value is T & `${number}` {
-  const numericChars = [...NUMERIC_CHAR];
-
-  return typeof value === "string" && (
-    split(value).every(i => numericChars.includes(i as any))
-  );
-}
-
-
-/**
- * **isNumberLike**(value)
- *
- * Type guard to validate that a value is either:
- *
- * - a numeric string literal which can be converted to a number
- * - an actual number
- *
- * **Related:** `isNumericString`
- */
-export function isNumberLike<T>(value: T): value is T & NumberLike {
-  const numericChars = [...NUMERIC_CHAR];
-
-  return typeof value === "string" && (
-    split(value).every(i => numericChars.includes(i as any))
-  )
-  ? true
-  : typeof value === "number" ? true : false;
-}
-

package/src/runtime/type-guards/isObject.ts

@@ -1,13 +0,0 @@
-
-
-/**
- * **isObject**(value)
- * 
- * Type guard used to detect whether the passed in value is an Object.
- * 
- * Note: an _array_ will **not** pass this test (although the _typeof_ operator
- * would have said it was an object)
- */
-export function isObject<T>(value: T): value is T & { [key: string | symbol]: unknown } {
-  return typeof value === "object" && value !== null && Array.isArray(value) === false;
-}

package/src/runtime/type-guards/isPhoneNumber.ts

@@ -1,35 +0,0 @@
-import { NUMERIC_CHAR, WHITESPACE_CHARS } from "inferred-types/dist/constants/index"
-import { retainChars, stripChars } from "src/runtime/index"
-
-/**
- * **isPhoneNumber**`(val)`
- *
- * Type guard which validates that a string is in the shape of a phone
- * number.
- *
- * - Only valid characters (numeric, whitespace, `+`, `-`, `.`, and parenthesis)
- * - at least 7 numeric characters, 8 if `+` character used
- * - leading character (after whitespace) must be numeric, `(` or `+`
- *
- * **Related:** `asPhoneNumber()`, `PhoneNumber`
- */
-export const isPhoneNumber = (val: unknown) => {
-    let svelte: string = String(val).trim();
-    let chars: readonly string[] = svelte.split("");
-    let numeric: string = retainChars(svelte, ...NUMERIC_CHAR)
-    let valid = ["+","(",...NUMERIC_CHAR];
-    let nothing: string = stripChars(svelte, ...[
-      ...NUMERIC_CHAR,
-      ...WHITESPACE_CHARS, "(", ")", "+", ".", "-"
-    ]);
-
-    return (
-      chars.every(i => valid.includes(i)) &&
-      svelte.startsWith(`+`)
-        ? numeric.length >= 8
-        : svelte.startsWith(`00`)
-        ? numeric.length >= 10
-        : numeric.length >= 7
-      && nothing === ""
-    )
-}

package/src/runtime/type-guards/isReadonlyArray.ts

@@ -1,17 +0,0 @@
-import { Tuple } from "inferred-types/dist/types/index";
-
-/**
- * **isReadonlyArray**(value)
- *
- * Type guard to detect if the type is an array (readonly).
- *
- * Note: at runtime we can't discern between a readonly array
- * and a normal one. If author is aware, however, that an array
- * indicates a readonly array then this type-guard will resolve
- * to a cleaner type.
- */
-export function isReadonlyArray<
-  T
->(value: T): value is Readonly<Exclude<T, undefined | string | null | boolean | number>> & Tuple {
-  return (Array.isArray(value) === true);
-}

package/src/runtime/type-guards/isRef.ts

@@ -1,15 +0,0 @@
-import { VueRef } from "inferred-types/dist/types/index";
-import { isObject } from "./isObject";
-
-
-/**
- * **isRef**(value)
- *
- * Type guard which check whether the passed in value is a VueJS `Ref<T>` value.
- */
-export function isRef<T>(value: T): value is T & VueRef<T> {
-
-  return isObject(value) &&
-    ("value" in value)
-    && Array.from(Object.keys(value)).includes("_value");
-}

package/src/runtime/type-guards/isRegExp.ts

@@ -1,37 +0,0 @@
-import { LikeRegExp } from "inferred-types/dist/types/index";
-import { isString } from "./isString"
-
-/**
- * Type guard that validates the the value passed in is
- * a regular expression.
- *
- * **Related:** `isLikeRegExp`
- */
-export const isRegExp = (val: unknown): val is RegExp => {
-  return val instanceof RegExp
-}
-
-
-/**
- * Type guard that validates the the value passed in is
- * a regular expression or a string that _can_ be turned
- * into a regular expression.
- *
- * **Related:** `isRegExp`
- */
-export const isLikeRegExp = (val: unknown): val is LikeRegExp => {
-  if (isRegExp(val)) {
-    return true;
-  }
-
-  if (isString(val)) {
-    try {
-      const _re = new RegExp(val);
-      return true
-    } catch {
-      return false
-    }
-  }
-
-  return false
-}

package/src/runtime/type-guards/isRuntimeUnion.ts

@@ -1,12 +0,0 @@
-import { RuntimeUnion } from "inferred-types/dist/types/index";
-
-
-/**
- * **isRuntimeUnion**
- *
- * A type guard which checks whether the passed in value is a `RuntimeUnion`.
- */
-export const isRuntimeUnion = <T extends unknown[]>(val: unknown): val is RuntimeUnion<T> => {
-
-  return typeof val === "object" && "kind" in (val as object) && (val as any).kind === "Union" ? true : false;
-}

package/src/runtime/type-guards/isScalar.ts

@@ -1,17 +0,0 @@
-import { Scalar } from "inferred-types/dist/types/index";
-import { isString } from "./isString";
-import { isNumber } from "./isNumber";
-import { isSymbol } from "./isSymbol";
-import { isNull } from "./isNull";
-
-
-
-/**
- * **isScalar**(value)
- *
- * Type guard to check whether the value passed in is a _scalar_ value.
- */
-export function isScalar<T>(value: T): value is T & Scalar {
-  return isString(value) || isNumber(value) || isSymbol(value) || isNull(value);
-
-}

package/src/runtime/type-guards/isSpecificConstant.ts

@@ -1,17 +0,0 @@
-
-import { Constant } from "inferred-types/dist/constants/index";
-import { isConstant } from "src/runtime/index";
-
-
-/**
- * **isSpecificConstant**(kind)
- *
- * A higher order type guard which tests for a specific `Constant` type.
- */
-export function isSpecificConstant<
-  TKind extends string
->(kind: TKind) {
-  return (value: unknown): value is Constant<TKind> => {
-    return isConstant(value) && value.kind === kind ? true : false;
-  };
-}

package/src/runtime/type-guards/isString.ts

@@ -1,13 +0,0 @@
-
-/**
- * **isString**
- *
- * Returns true or false on whether the passed in parameter is a
- * string (either a wide string or a string literal).
- *
- * The boolean return is traceable by the type system as well as the
- * runtime system.
- */
-export function isString<T>(value: T): value is T & string {
-  return (typeof value === "string");
-}

package/src/runtime/type-guards/isSymbol.ts

@@ -1,12 +0,0 @@
-
-/**
- * **isSymbol**(value)
- * 
- * Runtime type guard which narrows the passed in type
- * to being a **symbol** when condition is met.
- */
-export function isSymbol<T>(value: T): value is T & symbol {
-  return (typeof value === "symbol") as T extends symbol 
-    ? true 
-    : false;
-}

package/src/runtime/type-guards/isThenable.ts

@@ -1,8 +0,0 @@
-import { Thenable } from "inferred-types/dist/types/index";
-import { isObject } from "./isObject";
-/**
-* type guard which checks whether passed in `val` is a `Thenable` object
-*/
-export const isThenable = (val: unknown): val is Thenable => {
-  return isObject(val) && "then" in val && "catch" in val && typeof val.then === "function";
-}

package/src/runtime/type-guards/isTrimmable.ts

@@ -1,10 +0,0 @@
-import { isString } from "./isString";
-
-/**
- * **isTrimable**`(val)`
- *
- * tests whether a string has whitespace on either left or right edges.
- */
-export const isTrimable = <T>(val: T): val is T => {
-  return isString(val) && val !== val.trim();
-}

package/src/runtime/type-guards/isTrue.ts

@@ -1,8 +0,0 @@
-/**
- * **isTrue**(value)
- * 
- * Type guard which detects whether the given value is `true`.
- */
-export function isTrue(value: unknown): value is true {
-  return value === true;
-}

package/src/runtime/type-guards/isTruthy.ts

@@ -1,15 +0,0 @@
-
-import { FalsyValue } from "inferred-types/dist/types/index";
-import { FALSY_VALUES } from "inferred-types/dist/constants/index";
-
-
-/**
- * **isTruthy**
- *
- * Creates a TypeGuard which checks whether a value is considered _truthy_
- * in Javascript.
- */
-export const isTruthy = <V>(val: V): val is Exclude<V, FalsyValue> => {
-  return !FALSY_VALUES.includes(val as any);
-};
-

package/src/runtime/type-guards/isTypeToken.ts

@@ -1,20 +0,0 @@
-import {   TypeToken } from "inferred-types/dist/types/index";
-import {
-  isString,
-  startsWith,
-  endsWith
- } from "src/runtime/index";
-
-/**
- * **isTypeToken**(val)
- *
- * Type guard which checks whether the given value is a valid `TypeToken`
- */
-export function isTypeToken(val: unknown): val is TypeToken {
-
-  if (isString(val) && startsWith("<<")(val) && endsWith(">>")(val)) {
-    return true
-  } else {
-    return false;
-  }
-}

package/src/runtime/type-guards/isTypeTuple.ts

@@ -1,10 +0,0 @@
-import { Narrowable , TypeTuple } from "inferred-types/dist/types/index";
-
-/**
- * **isTypeTuple**(value)
- *
- * A type-guard which detects if passed in value is a `TypeTuple`.
- */
-export function isTypeTuple<T extends Narrowable, V extends TypeTuple<T, string>>(value: unknown | V): value is V {
-  return Array.isArray(value) && value.length === 3 && typeof value[1] === "function";
-}

package/src/runtime/type-guards/isUndefined.ts

@@ -1,10 +0,0 @@
-
-
-/**
- * **isUndefined**(value)
- * 
- * Type guard which determines whether a type is undefined or not.
- */
-export function isUndefined(value: unknown): value is undefined {
-  return (typeof value === "undefined") ? true : false;
-}

package/src/runtime/type-guards/isUnset.ts

@@ -1,26 +0,0 @@
-import { Unset } from "inferred-types/dist/types/index";
-import { isObject } from "./isObject"
-
-/**
- * **isUnset**`(val)`
- *
- * Type guard which validates that the value passed in `Unset`.
- *
- * **Related:** `isSet()`
- */
-export const isUnset = (val: unknown): val is Unset => {
-  return isObject(val) && val.kind === "Unset";
-};
-
-/**
- * **isSet**`(val)`
- *
- * Type guard which validates that the value passed in is **not** `Unset`.
- *
- * **Related:** `isUnset()`
- */
-export const isSet = <T>(val: T): val is Exclude<T,Unset> => {
-  return isObject(val)
-    ? val.kind !== "Unset" ? true : false
-    : true;
-}