type-plus 4.4.0 → 4.5.0

package/README.md

@@ -429,6 +429,7 @@ So you may encounter some weird behavior if your logic is complex.
 - `isSystemError(code, err)`: type guard `err` with Nodejs error code.
 - `omit(obj, ...props)`: omit properties from `obj`.
 - `pick(obj, ...props)`: pick properties from `obj`.
+- `record<K, V>(value?)`:  create a `Record<K, V>` without extra object prototype.
 - `required(...)`: merge options and removing `Partial<T>`. From [`unpartial`](https://github.com/unional/unpartial)
 - `requiredDeep(...)`: merge options deeply and removing `Partial<T>`. From [`unpartial`](https://github.com/unional/unpartial)
 - `split(target, ...splitters)`: split one object into multiple objects.

package/cjs/object/index.d.ts

@@ -21,6 +21,7 @@ export * from './omit';
 export type { OptionalKeys } from './OptionalKeys';
 export type { PartialExcept, PartialOmit, PartialPick } from './Partial';
 export * from './pick';
+export * from './record';
 export type { RecursiveIntersect } from './RecursiveIntersect';
 export type { RecursivePartial } from './RecursivePartial';
 export type { RecursiveRequired } from './RecursiveRequired';

package/cjs/object/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./mapKey"), exports);
 __exportStar(require("./mapProperties"), exports);
 __exportStar(require("./omit"), exports);
 __exportStar(require("./pick"), exports);
+__exportStar(require("./record"), exports);
 __exportStar(require("./reduceKey"), exports);
 __exportStar(require("./replaceProperty"), exports);
 __exportStar(require("./someKey"), exports);

package/cjs/object/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/object/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,6CAA0B;AAE1B,2CAAwB;AACxB,8CAA2B;AAC3B,4CAAyB;AACzB,+CAA4B;AAC5B,6CAA0B;AAC1B,2CAAwB;AACxB,gDAA6B;AAO7B,2CAAwB;AACxB,kDAA+B;AAC/B,yCAAsB;AAGtB,yCAAsB;AAItB,8CAA2B;AAC3B,oDAAiC;AAGjC,4CAAyB;AACzB,0CAAuB;AAEvB,6DAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/object/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,6CAA0B;AAE1B,2CAAwB;AACxB,8CAA2B;AAC3B,4CAAyB;AACzB,+CAA4B;AAC5B,6CAA0B;AAC1B,2CAAwB;AACxB,gDAA6B;AAO7B,2CAAwB;AACxB,kDAA+B;AAC/B,yCAAsB;AAGtB,yCAAsB;AACtB,2CAAwB;AAIxB,8CAA2B;AAC3B,oDAAiC;AAGjC,4CAAyB;AACzB,0CAAuB;AAEvB,6DAA0C"}

package/cjs/object/record.d.ts

@@ -0,0 +1,6 @@
+import { KeyTypes } from 'type-plus';
+import { Widen } from '../utils';
+/**
+ * Creates a `Record<Key, Value>`
+ */
+export declare function record<K extends KeyTypes, V>(value?: Record<K, V>): Record<Widen<K>, V>;

package/cjs/object/record.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.record = void 0;
+/**
+ * Creates a `Record<Key, Value>`
+ */
+function record(value) {
+    var r = Object.create(null);
+    return value ? Object.assign(r, value) : r;
+}
+exports.record = record;
+//# sourceMappingURL=record.js.map

package/cjs/object/record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../../ts/object/record.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,SAAgB,MAAM,CAAwB,KAAoB;IAChE,IAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC5C,CAAC;AAHD,wBAGC"}

package/cjs/testing/stub.d.ts

@@ -1,4 +1,6 @@
 import { AnyFunction } from '../function';
 import { RecursivePartial } from '../object';
-export declare type Stub<T> = T extends AnyFunction ? T : RecursivePartial<T>;
-export declare function stub<T>(stub: Stub<T>): T;
+export declare namespace stub {
+    type Param<T> = T extends AnyFunction ? T : RecursivePartial<T>;
+}
+export declare function stub<T>(stub?: stub.Param<T>): T;

package/cjs/testing/stub.js.map

@@ -1 +1 @@
-{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":";;;AAKA,SAAgB,IAAI,CAAI,IAAa;IACnC,OAAO,IAAS,CAAA;AAClB,CAAC;AAFD,oBAEC"}
+{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":";;;AAOA,SAAgB,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAFD,oBAEC"}

package/esm/object/index.js

@@ -10,6 +10,7 @@ export * from './mapKey';
 export * from './mapProperties';
 export * from './omit';
 export * from './pick';
+export * from './record';
 export * from './reduceKey';
 export * from './replaceProperty';
 export * from './someKey';

package/esm/object/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/object/index.ts"],"names":[],"mappings":"AAEA,cAAc,YAAY,CAAA;AAE1B,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAO7B,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AAGtB,cAAc,QAAQ,CAAA;AAItB,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AAGjC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AAEvB,cAAc,4BAA4B,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../ts/object/index.ts"],"names":[],"mappings":"AAEA,cAAc,YAAY,CAAA;AAE1B,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAO7B,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA;AAGtB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AAIxB,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AAGjC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AAEvB,cAAc,4BAA4B,CAAA"}

package/esm/object/record.js

@@ -0,0 +1,8 @@
+/**
+ * Creates a `Record<Key, Value>`
+ */
+export function record(value) {
+    const r = Object.create(null);
+    return value ? Object.assign(r, value) : r;
+}
+//# sourceMappingURL=record.js.map

package/esm/object/record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record.js","sourceRoot":"","sources":["../../ts/object/record.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,UAAU,MAAM,CAAwB,KAAoB;IAChE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC5C,CAAC"}

package/esm/testing/stub.js.map

@@ -1 +1 @@
-{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,IAAI,CAAI,IAAa;IACnC,OAAO,IAAS,CAAA;AAClB,CAAC"}
+{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-plus",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Provides additional types for TypeScript.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {

package/ts/object/index.ts

@@ -21,6 +21,7 @@ export * from './omit'
 export type { OptionalKeys } from './OptionalKeys'
 export type { PartialExcept, PartialOmit, PartialPick } from './Partial'
 export * from './pick'
+export * from './record'
 export type { RecursiveIntersect } from './RecursiveIntersect'
 export type { RecursivePartial } from './RecursivePartial'
 export type { RecursiveRequired } from './RecursiveRequired'

package/ts/object/record.spec.ts

@@ -0,0 +1,54 @@
+import { isType, KeyTypes, record } from '..'
+
+test('create an empty record with value default to unknown', () => {
+  const a = record()
+  a[1] = 2
+  a['a'] = 'b'
+  a[Symbol()] = true
+  isType.equal<true, Record<KeyTypes, unknown>, typeof a>()
+})
+
+test('specify key and value types', () => {
+  const a = record<string, number>()
+  // even though the key type is string,
+  // by default JavaScript will cast number index to string
+  // so TypeScript also allows it.
+  a[1] = 2
+  a['a'] = 3
+  isType.equal<true, Record<string, number>, typeof a>()
+})
+
+test('no prototype', () => {
+  const a = record()
+  expect(Object.getPrototypeOf(a)).toBeNull()
+})
+
+test('infer type from initial value, the key type is widen', () => {
+  const stringRecord = record({ a: 1 })
+  isType.equal<true, Record<string, number>, typeof stringRecord>()
+
+  const numberRecord = record({ 1: 3 })
+  isType.equal<true, Record<number, number>, typeof numberRecord>()
+
+  const stringConstRecord = record({ a: 1 } as const)
+  isType.equal<true, Record<string, 1>, typeof stringConstRecord>()
+
+  const stringConstRecord2 = record({ a: 1 as const })
+  isType.equal<true, Record<string, 1>, typeof stringConstRecord2>()
+
+  const stringConstRecord3 = record({ a: 1 as const, b: 'b' })
+  isType.equal<true, Record<string, 1 | string>, typeof stringConstRecord3>()
+
+  const stringConstRecord4 = record({ a: 1 as const, b: 'b' as const })
+  isType.equal<true, Record<string, 1 | 'b'>, typeof stringConstRecord4>()
+})
+
+test('no prototype with initial value', () => {
+  const a = record({ a: 1 })
+  expect(Object.getPrototypeOf(a)).toBeNull()
+})
+
+test('Object.keys() gets the keys of the initial value', () => {
+  const a = record({ a: 1, b: 2 })
+  expect(Object.keys(a)).toEqual(['a', 'b'])
+})

package/ts/object/record.ts

@@ -0,0 +1,10 @@
+import { KeyTypes } from 'type-plus'
+import { Widen } from '../utils'
+
+/**
+ * Creates a `Record<Key, Value>`
+ */
+export function record<K extends KeyTypes, V>(value?: Record<K, V>): Record<Widen<K>, V> {
+  const r = Object.create(null)
+  return value ? Object.assign(r, value) : r
+}

package/ts/testing/stub.spec.ts

@@ -29,3 +29,10 @@ test('stub function params can be omitted', () => {
   expect(a('1', 1)).toBe(false)
   isType.equal<true, typeof a, typeof real>()
 })
+
+test('stub input can be omitted', () => {
+  const real = { a: 1, b: { c: 2 }, d: 3 }
+
+  const a = stub<typeof real>()
+  isType.equal<true, typeof a, typeof real>()
+})

package/ts/testing/stub.ts

@@ -1,8 +1,10 @@
 import { AnyFunction } from '../function'
 import { RecursivePartial } from '../object'
 
-export type Stub<T> = T extends AnyFunction ? T : RecursivePartial<T>
+export namespace stub {
+  export type Param<T> = T extends AnyFunction ? T : RecursivePartial<T>
+}
 
-export function stub<T>(stub: Stub<T>) {
+export function stub<T>(stub?: stub.Param<T>) {
   return stub as T
 }