@stryke/type-checks 0.4.3 → 0.5.5

package/dist/get-object-tag.d.ts

@@ -1,7 +0,0 @@
-/**
- * Gets the `toStringTag` of `obj`.
- *
- * @param value - The obj to query.
- * @returns Returns the `toStringTag`.
- */
-export declare const getObjectTag: (value: unknown) => string;

package/dist/index.d.ts

@@ -1,50 +0,0 @@
-/**
- * The type-checks library used by Storm Software for building TypeScript applications.
- *
- * @remarks
- * A package containing many base TypeScript type definitions that are shared across many projects.
- *
- * @packageDocumentation
- */
-export * from "./get-object-tag";
-export * from "./is-array-like";
-export * from "./is-async-iterable";
-export * from "./is-bigint";
-export * from "./is-boolean";
-export * from "./is-buffer";
-export * from "./is-collection";
-export * from "./is-date";
-export * from "./is-deep-key";
-export * from "./is-empty";
-export * from "./is-empty-object";
-export * from "./is-empty-string";
-export * from "./is-equal";
-export * from "./is-error";
-export * from "./is-file-result";
-export * from "./is-float";
-export * from "./is-function";
-export * from "./is-integer";
-export * from "./is-mergeable-object";
-export * from "./is-not-empty";
-export * from "./is-null";
-export * from "./is-number";
-export * from "./is-object";
-export * from "./is-object-index";
-export * from "./is-plain-object";
-export * from "./is-primitive";
-export * from "./is-promise";
-export * from "./is-react-element";
-export * from "./is-ref";
-export * from "./is-regexp";
-export * from "./is-select-option";
-export * from "./is-set";
-export * from "./is-set-object";
-export * from "./is-set-string";
-export * from "./is-string";
-export * from "./is-symbol";
-export * from "./is-typed";
-export * from "./is-typed-array";
-export * from "./is-undefined";
-export * from "./is-url";
-export * from "./property-exists";
-export * from "./type-detect";

package/dist/is-async-iterable.d.ts

@@ -1,7 +0,0 @@
-/**
- * Check if the provided value's type is `AsyncIterable`
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the object provided is `AsyncIterable`
- */
-export declare const isAsyncIterable: (value: unknown) => value is AsyncIterable<unknown>;

package/dist/is-buffer.d.ts

@@ -1,5 +0,0 @@
-export declare const isBufferExists: boolean;
-/**
- * Check if the provided value's type is `Buffer`
- */
-export declare const isBuffer: typeof Buffer.isBuffer;

package/dist/is-collection.d.ts

@@ -1,8 +0,0 @@
-import type { Collection } from "@stryke/types/base";
-/**
- * Check if the provided value's type is `Collection`
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided is of type `Collection`
- */
-export declare function isCollection(value: any): value is Collection;

package/dist/is-deep-key.d.ts

@@ -1,35 +0,0 @@
-import type { DeepKey } from "@stryke/types/object";
-/**
- * Checks if a given key is a deep key.
- *
- * A deep key is a string that contains a dot (.) or square brackets with a property accessor.
- *
- * @example
- * isDeepKey('a.b') // true
- * isDeepKey('a[b]') // true
- * isDeepKey('a') // false
- * isDeepKey(123) // false
- * isDeepKey('a.b.c') // true
- * isDeepKey('a[b][c]') // true
- *
- * @param key - The key to check.
- * @returns Returns true if the key is a deep key, otherwise false.
- */
-export declare function isDeepKey(key: PropertyKey): key is DeepKey<any>;
-/**
- * Checks if a given key is a deep key or normal (shallow key).
- *
- * A deep key is a string that contains a dot (.) or square brackets with a property accessor.
- *
- * @example
- * isDeepKey('a.b') // true
- * isDeepKey('a[b]') // true
- * isDeepKey('a') // true
- * isDeepKey(123) // false
- * isDeepKey('a.b.c') // true
- * isDeepKey('a[b][c]') // true
- *
- * @param key - The key to check.
- * @returns Returns true if the key is a deep key, otherwise false.
- */
-export declare function isKeyOrDeepKey(key: PropertyKey): key is DeepKey<any>;

package/dist/is-empty-string.d.ts

@@ -1,7 +0,0 @@
-/**
- * Determine if the type is string and is empty
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided is of type `""`
- */
-export declare const isEmptyString: (value: unknown) => value is string;

package/dist/is-empty.d.ts

@@ -1,8 +0,0 @@
-/**
- * Check if the provided value's type is `null` or `undefined`
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided is of type `null` or `undefined`
- */
-export declare const isEmpty: (value: unknown) => boolean;
-export declare const isEmptyAnything: (value: any) => boolean;

package/dist/is-equal.d.ts

@@ -1 +0,0 @@
-export declare const isEqual: <TType>(x: TType, y: TType) => boolean;

package/dist/is-file-result.d.ts

@@ -1,8 +0,0 @@
-import type { FileResult } from "@stryke/types/file";
-/**
- * Check if the provided value is a `FileResult` object
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided is a `FileResult` object
- */
-export declare const isFileResult: (value: any) => value is FileResult;

package/dist/is-float.d.ts

@@ -1,8 +0,0 @@
-import type { Float } from "@stryke/types/number";
-/**
- * Check if the provided value's type is a float
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided is of type `number` and is a float
- */
-export declare const isFloat: <T extends number>(value: T) => value is Float<T>;

package/dist/is-function.d.ts

@@ -1,10 +0,0 @@
-import type { AnyFunction } from "@stryke/types/base";
-export declare function isSyncFunction(value?: any): value is AnyFunction;
-export declare function isAsyncFunction(value?: any): value is AnyFunction;
-/**
- * Check if the provided value's type is `Function`
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided is of type `Function`
- */
-export declare const isFunction: (value: unknown) => value is AnyFunction;

package/dist/is-mergeable-object.d.ts

@@ -1 +0,0 @@
-export declare const isMergeableObject: (value: any) => boolean;

package/dist/is-null.d.ts

@@ -1 +0,0 @@
-export declare const isNull: (value: unknown) => value is null;

package/dist/is-object-index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Checks if the given value is an object index.
- *
- * @param value - The value to check.
- * @returns Returns `true` if the value is an object index, otherwise `false`.
- */
-export declare function isObjectIndex(value: PropertyKey): value is string | number | symbol;

package/dist/is-primitive.d.ts

@@ -1 +0,0 @@
-export declare const isPrimitive: (value: unknown) => boolean;

package/dist/is-react-element.d.ts

@@ -1 +0,0 @@
-export declare const isReactElement: (value: any) => boolean;

package/dist/is-ref.d.ts

@@ -1,8 +0,0 @@
-import type { RefObject } from "@stryke/types/base";
-/**
- * Check if the provided value's type is a ref
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the object provided is of type ref
- */
-export declare const isRef: <TRef = unknown>(value: unknown) => value is RefObject<TRef>;

package/dist/is-select-option.d.ts

@@ -1,8 +0,0 @@
-import type { SelectOption } from "@stryke/types/form";
-/**
- * Check if the provided value's type is SelectOption
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the object provided is of type SelectOption
- */
-export declare const isSelectOption: (value: unknown) => value is SelectOption;

package/dist/is-string.d.ts

@@ -1 +0,0 @@
-export declare const isString: (value: unknown) => value is string;

package/dist/is-symbol.d.ts

@@ -1 +0,0 @@
-export declare const isSymbol: (value: unknown) => value is symbol;

package/dist/is-typed-array.d.ts

@@ -1 +0,0 @@
-export declare function isTypedArray(obj: any): obj is Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | BigUint64Array | Int8Array | Int16Array | Int32Array | BigInt64Array | Float32Array | Float64Array;

package/dist/is-typed.d.ts

@@ -1,8 +0,0 @@
-import type { Typed } from "@stryke/types/base";
-/**
- * Check if the provided value has a `__typename` property
- *
- * @param value - The value to type check
- * @returns An indicator specifying if the value provided has a `__typename` property
- */
-export declare const isTyped: (value: unknown) => value is Typed;

package/dist/is-undefined.d.ts

@@ -1 +0,0 @@
-export declare const isUndefined: (value: unknown) => value is undefined;

package/dist/type-detect.d.ts

@@ -1 +0,0 @@
-export declare function typeDetect(obj: unknown): string;