@stryke/types 0.5.1 → 0.6.0

package/dist/{utility-types/object.d.ts → object.d.ts}

@@ -68,8 +68,6 @@ export type LiteralKeyOf<T> = keyof {
  * const pet: Pet2 = '';
  * // You **will** get auto-completion for `dog` and `cat` literals.
  * ```
- *
- * @category Type
  */
 export type LiteralUnion<LiteralType, BaseType extends Primitive> = (BaseType & Record<never, never>) | LiteralType;
 /**
@@ -155,9 +153,6 @@ type StrictPropertyOf<BaseType, Key extends keyof BaseType, Options extends GetO
  *
  * array = split(items, ',');
  * ```
- *
- * @category String
- * @category Template literal
  */
 export type Split<S extends string, Delimiter extends string> = S extends `${infer Head}${Delimiter}${infer Tail}` ? [Head, ...Split<Tail, Delimiter>] : S extends Delimiter ? [] : [S];
 /**
@@ -174,7 +169,7 @@ export type Split<S extends string, Delimiter extends string> = S extends `${inf
  */
 export type ToPath<S extends string> = Split<FixPathSquareBrackets<S>, ".">;
 /**
- * Replaces square-bracketed dot notation with dots, for example, `foo[0].bar` -> `foo.0.bar`.
+ * Replaces square-bracketed dot notation with dots, for example, `foo[0].bar` -\> `foo.0.bar`.
  */
 type FixPathSquareBrackets<Path extends string> = Path extends `[${infer Head}]${infer Tail}` ? Tail extends `[${string}` ? `${Head}.${FixPathSquareBrackets<Tail>}` : `${Head}${FixPathSquareBrackets<Tail>}` : Path extends `${infer Head}[${infer Middle}]${infer Tail}` ? `${Head}.${FixPathSquareBrackets<`[${Middle}]${Tail}`>}` : Path;
 /**
@@ -267,10 +262,6 @@ type PropertyOf<BaseType, Key extends string, Options extends GetOptions = {}> =
  * Get<string[], '3', {strict: false}> //=> string
  * Get<Record<string, string>, 'foo', {strict: true}> // => string
  * ```
- *
- * @category Object
- * @category Array
- * @category Template literal
  */
 export type Get<BaseType, Path extends readonly string[] | string, Options extends GetOptions = NonNullable<unknown>> = GetWithPath<BaseType, Path extends string ? ToPath<Path> : Path, Options>;
 /**
@@ -315,8 +306,6 @@ export type Get<BaseType, Path extends readonly string[] | string, Options exten
  * type Intersection = UnionToIntersection<Union>;
  * //=> {a1(): void; b1(): void; a2(argA: string): void; b2(argB: string): void}
  * ```
- *
- * @category Type
  */
 export type UnionToIntersection<Union> = (Union extends unknown ? (_distributedUnion: Union) => void : never) extends (_mergedIntersection: infer Intersection) => void ? // The `& Union` is to allow indexing by the resulting type
 Intersection & Union : never;
@@ -387,9 +376,6 @@ Intersection & Union : never;
  * //  };
  * // }
  * ```
- *
- * @category Object
- * @category Array
  */
 export type PickDeep<T, PathUnion extends Paths<T>> = T extends NonRecursiveType ? never : T extends UnknownArray ? UnionToIntersection<{
     [P in PathUnion]: InternalPickDeep<T, P>;

package/dist/{utility-types/package-json.d.ts → package-json.d.ts}

@@ -128,8 +128,7 @@ export interface PackageJson {
      * Docs:
      * - https://nodejs.org/docs/latest-v14.x/api/esm.html#esm_package_json_type_field
      *
-     * @default 'commonjs'
-     * @since Node.js v14
+     * @defaultValue 'commonjs'
      */
     type?: "module" | "commonjs";
     /**
@@ -139,8 +138,6 @@ export interface PackageJson {
      *
      * Docs:
      * - https://nodejs.org/docs/latest-v14.x/api/esm.html#esm_exports_sugar
-     *
-     * @since Node.js v12.7
      */
     exports?: PackageJsonExports;
     /**
@@ -234,7 +231,8 @@ export interface PackageJson {
          *
          * When set to `true`, the project will be symlinked from the
          * `publishConfig.directory` location during local development.
-         * @default true
+         *
+         * @defaultValue true
          */
         linkDirectory?: boolean;
     } & Pick<PackageJson, "bin" | "main" | "exports" | "types" | "typings" | "module" | "browser" | "unpkg" | "typesVersions" | "os" | "cpu">;

package/dist/{utility-types/string.d.ts → string.d.ts}

@@ -22,10 +22,6 @@ import type { NegativeInfinity, PositiveInfinity } from "./number";
  * type NegativeInfinity = StringToNumber<'-Infinity'>;
  * //=> -Infinity
  * ```
- *
- * @category String
- * @category Numeric
- * @category Template literal
  */
 export type StringToNumber<S extends string> = S extends `${infer N extends number}` ? N : S extends "Infinity" ? PositiveInfinity : S extends "-Infinity" ? NegativeInfinity : never;
 /**
@@ -45,9 +41,6 @@ export type StringToNumber<S extends string> = S extends `${infer N extends numb
  * StartsWith<'abcde', string>;
  * //=> never
  * ```
- *
- * @category String
- * @category Template literal
  */
 export type StartsWith<S extends string, SearchString extends string> = string extends S | SearchString ? never : S extends `${SearchString}${string | number | bigint | boolean | null | undefined}` ? true : false;
 /**
@@ -61,9 +54,6 @@ export type StartsWith<S extends string, SearchString extends string> = string e
  * StringLength<string>;
  * //=> never
  * ```
- *
- * @category String
- * @category Template literal
  */
 export type StringLength<S extends string> = string extends S ? never : StringToArray<S>["length"];
 /**
@@ -77,8 +67,6 @@ export type StringLength<S extends string> = string extends S ? never : StringTo
  * StringToArray<string>;
  * //=> never
  * ```
- *
- * @category String
  */
 export type StringToArray<S extends string, Result extends string[] = []> = string extends S ? never : S extends `${infer F}${infer R}` ? StringToArray<R, [...Result, F]> : Result;
 export type UpperCaseCharacters = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z";

package/dist/{utility-types/tsconfig.d.ts → tsconfig.d.ts}

@@ -749,8 +749,6 @@ export interface References {
 }
 /**
  * Type for [TypeScript's `tsconfig.json` file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) (TypeScript 3.7).
- *
- * @category File
  */
 export interface TsConfigJson {
     /**

package/dist/{utility-types/utilities.d.ts → utilities.d.ts}

@@ -44,7 +44,7 @@ export interface NameValuePair<TValue, TName = string> {
  * @param A2 - to cast to
  * @returns `A1 | A2`
  */
-export type Cast<A1 extends any, A2 extends any> = A1 extends A2 ? A1 : A2;
+export type Cast<A1, A2> = A1 extends A2 ? A1 : A2;
 export type DeepReadonly<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepReadonlyArray<U> : DeepReadonlyObject<T>;
 export type DeepReadonlyArray<T> = ReadonlyArray<DeepReadonly<T>>;
 export type DeepReadonlyObject<T> = {

package/dist/validations.cjs

@@ -0,0 +1 @@
+"use strict";