type-plus 4.1.0 → 4.2.0

package/README.md

@@ -345,7 +345,7 @@ type No = IsAny<1, 'yes', 'no'> // 'no'
 
 - `CommonPropKeys<A>`: gets common keys inside the records in the array `A` (deprecate `CommonKeys`).
 - `Concat<A, B>`: `[...A, ...B]`.
-- `CreateTuple<L, T>`: creates `Tuple<T>` with `L` number of elements.
+- `CreateTuple<L, T>`: Creates `Tuple<T>` with `L` number of elements.
 - `DropFirst<A>`: drops the first value type of `A`.
 - `DropLast<A>`: drops the last value type of `A`.
 - `Filter<A, Criteria>`: gets the array of types satisfying `Criteria` in `A`.
@@ -354,13 +354,14 @@ type No = IsAny<1, 'yes', 'no'> // 'no'
 - `Head<A>`: gets the first entry in the array.
 - `IntersectOfProps<A, K>`: gets the intersect of `A[K]` types (deprecate `MapToProp`)
 - `IsArray<T>`: `logical` predicate for `Array`.
+- `Last<A>`: gets the last type of an array or tuple.
 - `literalArray(...entries)`: return an array whose items are restricted to the provided literals.
 - `PadLeft<A, Total, PadWith>`: pads `A` with `PadWith` if the length of `A` is less than `L`.
 - `reduceWhile()`: `reduce()` with predicate for early termination. \
   A simple version of the same function in the `ramda` package.
 - `Reverse<A>`: reverses the order of `A`.
 - `Some<A, Criteria>`: true if some elements in `A` matches `Criteria`.
-- `Tail<A>`: gets the remaining entries in the array except the first.
+- `Tail<A>`: Gets the types of a tuple except the first entry.
 - `UnionOfProps<A, K>`: gets the union of `A[K]` types (deprecate `PropUnion`).
 - `UnionOfValues<A>`: gets the union of value types in `A` (deprecate `ArrayValue`).
 

package/cjs/array/CreateTuple.d.ts

@@ -1,4 +1,7 @@
 import { IsPositive } from '../math';
+/**
+ * Creates `Tuple<T>` with `L` number of elements.
+ */
 export declare type CreateTuple<L extends number, T = any> = IsPositive<L> extends true ? Device<[], L, T> : never;
 declare type Device<R extends any[], L extends number, T> = R['length'] extends L ? R : Device<[T, ...R], L, T>;
 export {};

package/cjs/array/Last.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Get the last type of an array or tuple.
+ */
+export declare type Last<T extends any[]> = T extends [...any[], infer R] ? R : T[0];

package/cjs/array/Last.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Last.js.map

package/cjs/array/Last.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Last.js","sourceRoot":"","sources":["../../ts/array/Last.ts"],"names":[],"mappings":""}

package/cjs/array/Tail.d.ts

@@ -1,2 +1,5 @@
 import { UnionOfValues } from './UnionOfValues';
+/**
+ * Gets the types of a tuple except the first entry.
+ */
 export declare type Tail<T extends any[]> = T['length'] extends 0 ? never : (T extends [any, ...infer Tail] ? (Tail extends UnionOfValues<T>[] ? Tail : never) : T);

package/cjs/array/index.d.ts

@@ -9,6 +9,7 @@ export type { FindLast } from './FindLast';
 export type { Head } from './Head';
 export type { IntersectOfProps, MapToProp } from './IntersectOfProps';
 export type { IsArray } from './IsArray';
+export type { Last } from './Last';
 export * from './literalArray';
 export type { PadLeft } from './PadLeft';
 export * from './reduceWhile';

package/cjs/array/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAWA,iDAA8B;AAE9B,gDAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAYA,iDAA8B;AAE9B,gDAA6B"}

package/cjs/object/split.d.ts

@@ -5,6 +5,10 @@ declare type Splitter<T extends AnyRecord> = Partial<{
 declare type Split<T extends AnyRecord, S extends AnyRecord> = {
     [k in keyof S]: NonNullable<T[k]> | S[k];
 };
+/**
+ * Split an object into multiple objects.
+ * @returns [...entries, remaining]
+ */
 export declare function split<T extends AnyRecord, S1 extends Splitter<T>>(target: T, split1: S1): [
     Split<T, S1>,
     Omit<T, keyof S1>

package/cjs/object/split.js.map

@@ -1 +1 @@
-{"version":3,"file":"split.js","sourceRoot":"","sources":["../../ts/object/split.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wBAAiD;AAyLjD,SAAgB,KAAK,CAAC,MAAiB;IAAE,mBAAyB;SAAzB,UAAyB,EAAzB,qBAAyB,EAAzB,IAAyB;QAAzB,kCAAyB;;IAChE,IAAM,MAAM,GAAc,EAAE,CAAA;IAC5B,IAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,UAAA,CAAC,IAAI,OAAA,IAAA,eAAW,EAAC,CAAC,EAAE,UAAC,CAAC,EAAE,CAAC,YAAK,OAAA,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA,EAAA,EAAE,EAAe,CAAC,EAA1F,CAA0F,CAAC,CAAA;IACxH,IAAM,CAAC,GAAG,IAAA,eAAW,EAAC,MAAM,EAAE,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAArC,CAAqC,EAAE,EAAe,CAAC,CAAA;IAC/F,uCAAW,CAAC,UAAE,CAAC,UAAC;AAClB,CAAC;AALD,sBAKC"}
+{"version":3,"file":"split.js","sourceRoot":"","sources":["../../ts/object/split.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wBAAiD;AA6LjD,SAAgB,KAAK,CAAC,MAAiB;IAAE,mBAAyB;SAAzB,UAAyB,EAAzB,qBAAyB,EAAzB,IAAyB;QAAzB,kCAAyB;;IAChE,IAAM,MAAM,GAAc,EAAE,CAAA;IAC5B,IAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,UAAA,CAAC,IAAI,OAAA,IAAA,eAAW,EAAC,CAAC,EAAE,UAAC,CAAC,EAAE,CAAC,YAAK,OAAA,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,CAAC,CAAC,mCAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA,EAAA,EAAE,EAAe,CAAC,EAA1F,CAA0F,CAAC,CAAA;IACxH,IAAM,CAAC,GAAG,IAAA,eAAW,EAAC,MAAM,EAAE,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAArC,CAAqC,EAAE,EAAe,CAAC,CAAA;IAC/F,uCAAW,CAAC,UAAE,CAAC,UAAC;AAClB,CAAC;AALD,sBAKC"}

package/esm/array/Last.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Last.js.map

package/esm/array/Last.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Last.js","sourceRoot":"","sources":["../../ts/array/Last.ts"],"names":[],"mappings":""}

package/esm/array/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":"AAWA,cAAc,gBAAgB,CAAA;AAE9B,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/array/index.ts"],"names":[],"mappings":"AAYA,cAAc,gBAAgB,CAAA;AAE9B,cAAc,eAAe,CAAA"}

package/esm/object/split.js.map

@@ -1 +1 @@
-{"version":3,"file":"split.js","sourceRoot":"","sources":["../../ts/object/split.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,WAAW,EAAE,MAAM,IAAI,CAAA;AAyLjD,MAAM,UAAU,KAAK,CAAC,MAAiB,EAAE,GAAG,SAAsB;IAChE,MAAM,MAAM,GAAc,EAAE,CAAA;IAC5B,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAe,CAAC,CAAC,CAAA;IACxH,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAe,CAAC,CAAA;IAC/F,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;AAClB,CAAC"}
+{"version":3,"file":"split.js","sourceRoot":"","sources":["../../ts/object/split.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,WAAW,EAAE,MAAM,IAAI,CAAA;AA6LjD,MAAM,UAAU,KAAK,CAAC,MAAiB,EAAE,GAAG,SAAsB;IAChE,MAAM,MAAM,GAAc,EAAE,CAAA;IAC5B,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAe,CAAC,CAAC,CAAA;IACxH,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAe,CAAC,CAAA;IAC/F,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;AAClB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-plus",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Provides additional types for `typescript`.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {

package/ts/array/CreateTuple.ts

@@ -1,7 +1,10 @@
-import { IsPositive } from '../math'
-
-export type CreateTuple<L extends number, T = any> =
-  IsPositive<L> extends true ? Device<[], L, T> : never
-
-type Device<R extends any[], L extends number, T> =
-  R['length'] extends L ? R : Device<[T, ...R], L, T>
+import { IsPositive } from '../math'
+
+/**
+ * Creates `Tuple<T>` with `L` number of elements.
+ */
+export type CreateTuple<L extends number, T = any> =
+  IsPositive<L> extends true ? Device<[], L, T> : never
+
+type Device<R extends any[], L extends number, T> =
+  R['length'] extends L ? R : Device<[T, ...R], L, T>

package/ts/array/Last.spec.ts

@@ -0,0 +1,32 @@
+import { AnyFunction, isType } from '..'
+import { Last } from './Last'
+
+test('any array', () => {
+  type A = Last<any[]>
+  isType.equal<true, any, A>()
+})
+
+test('never array', () => {
+  type A = Last<never[]>
+  isType.equal<true, never, A>()
+})
+
+test('typed array', () => {
+  type A = Last<string[]>
+  isType.equal<true, string, A>()
+})
+
+test('function array', () => {
+  type A = Last<AnyFunction[]>
+  isType.equal<true, AnyFunction, A>()
+})
+
+test('empty tuple gets undefined', () => {
+  type A = Last<[]>
+  isType.equal<true, undefined, A>()
+})
+
+test('tuple with function', () => {
+  type A = Last<[number, AnyFunction]>
+  isType.equal<true, AnyFunction, A>()
+})

package/ts/array/Last.ts

@@ -0,0 +1,4 @@
+/**
+ * Get the last type of an array or tuple.
+ */
+export type Last<T extends any[]> = T extends [...any[], infer R] ? R : T[0]

package/ts/array/Tail.spec.ts

@@ -1,32 +1,32 @@
-import { isType, Tail } from '..'
-
-test('get tail types', () => {
-  type S = [1, 'a', 'b']
-  type A = Tail<S>
-
-  isType.equal<true, ['a', 'b'], A>()
-})
-
-test('empty tuple gets never', () => {
-  type S = []
-  type A = Tail<S>
-
-  isType.equal<true, never, A>()
-})
-
-test('array gets same type', () => {
-  type A = Tail<string[]>
-
-  isType.equal<true, string[], A>()
-})
-
-test('union array', () => {
-  type A = Tail<Array<string | boolean>>
-
-  isType.equal<true, Array<string | boolean>, A>()
-})
-
-test('tuple with rest', () => {
-  type A = Tail<[number, ...string[]]>
-  isType.equal<true, string[], A>()
-})
+import { isType, Tail } from '..'
+
+test('get tail types', () => {
+  type S = [1, 'a', 'b']
+  type A = Tail<S>
+
+  isType.equal<true, ['a', 'b'], A>()
+})
+
+test('empty tuple gets never', () => {
+  type S = []
+  type A = Tail<S>
+
+  isType.equal<true, never, A>()
+})
+
+test('array gets same type', () => {
+  type A = Tail<string[]>
+
+  isType.equal<true, string[], A>()
+})
+
+test('union array', () => {
+  type A = Tail<Array<string | boolean>>
+
+  isType.equal<true, Array<string | boolean>, A>()
+})
+
+test('tuple with rest', () => {
+  type A = Tail<[number, ...string[]]>
+  isType.equal<true, string[], A>()
+})

package/ts/array/Tail.ts

@@ -1,7 +1,10 @@
-import { UnionOfValues } from './UnionOfValues'
-
-export type Tail<T extends any[]> = T['length'] extends 0
-  ? never
-  : (T extends [any, ...infer Tail]
-    ? (Tail extends UnionOfValues<T>[] ? Tail : never)
-    : T)
+import { UnionOfValues } from './UnionOfValues'
+
+/**
+ * Gets the types of a tuple except the first entry.
+ */
+export type Tail<T extends any[]> = T['length'] extends 0
+  ? never
+  : (T extends [any, ...infer Tail]
+    ? (Tail extends UnionOfValues<T>[] ? Tail : never)
+    : T)

package/ts/array/index.ts

@@ -9,6 +9,7 @@ export type { FindLast } from './FindLast'
 export type { Head } from './Head'
 export type { IntersectOfProps, MapToProp } from './IntersectOfProps'
 export type { IsArray } from './IsArray'
+export type { Last } from './Last'
 export * from './literalArray'
 export type { PadLeft } from './PadLeft'
 export * from './reduceWhile'

package/ts/object/split.ts

@@ -3,6 +3,10 @@ import { AnyRecord, Omit, reduceByKey } from '..'
 type Splitter<T extends AnyRecord> = Partial<{ [k in keyof T]: T[k] | undefined }>
 type Split<T extends AnyRecord, S extends AnyRecord> = { [k in keyof S]: NonNullable<T[k]> | S[k] }
 
+/**
+ * Split an object into multiple objects.
+ * @returns [...entries, remaining]
+ */
 export function split<
   T extends AnyRecord,
   S1 extends Splitter<T>