feat(types): OwnPropertyKey

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

__tests__/setup/matchers/descriptor.ts

@@ -4,7 +4,7 @@
  */
 
 import type { PropertyDescriptor } from '#src/interfaces'
-import type { Optional } from '#src/types'
+import type { Optional, OwnPropertyKey } from '#src/types'
 import type { MatcherState, SyncExpectationResult } from '@vitest/expect'
 import isEqual from 'lodash.isequal'
 
@@ -18,14 +18,14 @@ import isEqual from 'lodash.isequal'
  * @this {MatcherState}
  *
  * @param {unknown} target - Value to look for `key` in
- * @param {string | symbol} key - Property to check
+ * @param {OwnPropertyKey} key - Property to check
  * @param {PropertyDescriptor<T>} descriptor - Expected property descriptor
  * @return {SyncExpectationResult} Expectation result
  */
 function descriptor<T = any>(
   this: MatcherState,
   target: unknown,
-  key: string | symbol,
+  key: OwnPropertyKey,
   descriptor: PropertyDescriptor<T>
 ): SyncExpectationResult {
   /**

src/types/__tests__/get.spec-d.ts

@@ -202,7 +202,7 @@ describe('unit-d:types/Get', () => {
     })
   })
 
-  describe('K extends string | symbol', () => {
+  describe('K extends OwnPropertyKey', () => {
     it('should equal F if K cannot index T', () => {
       // Arrange
       type K = typeof opaque | 'vrm'

src/types/__tests__/has-key.spec-d.ts

@@ -15,6 +15,7 @@ import type Numeric from '../numeric'
 import type NegativeNumeric from '../numeric-negative'
 import type { tag as opaque } from '../opaque'
 import type PropertyKey from '../property-key'
+import type OwnPropertyKey from '../property-key-own'
 import type Stringify from '../stringify'
 
 describe('unit-d:types/HasKey', () => {
@@ -175,7 +176,7 @@ describe('unit-d:types/HasKey', () => {
         type T = string
 
         it('should equal false if K cannot index T', () => {
-          expectTypeOf<TestSubject<T, string | symbol>>().toEqualTypeOf<false>()
+          expectTypeOf<TestSubject<T, OwnPropertyKey>>().toEqualTypeOf<false>()
         })
 
         it('should equal true if K is explicitly defined on T', () => {
@@ -246,7 +247,7 @@ describe('unit-d:types/HasKey', () => {
       type T = Vehicle[]
 
       it('should equal false if K cannot index T', () => {
-        expectTypeOf<TestSubject<T, string | symbol>>().toEqualTypeOf<false>()
+        expectTypeOf<TestSubject<T, OwnPropertyKey>>().toEqualTypeOf<false>()
       })
 
       it('should equal true if K is explicitly defined on T', () => {

src/types/__tests__/omit-index-signature.spec-d.ts

@@ -13,6 +13,7 @@ import type Objectify from '../objectify'
 import type Omit from '../omit'
 import type TestSubject from '../omit-index-signature'
 import type PropertyKey from '../property-key'
+import type OwnPropertyKey from '../property-key-own'
 import type Stringify from '../stringify'
 import type Times from '../times'
 
@@ -44,9 +45,9 @@ describe('unit-d:types/OmitIndexSignature', () => {
       type T = {
         [x: Join<['data', string], Dot>]: string
         [x: Numeric]: number
+        [x: OwnPropertyKey]: any
         [x: Stringify<bigint>]: string
         [x: number]: number
-        [x: string | symbol]: any
         hello: 'world'
         foo?: 'bar'
       }
@@ -181,7 +182,7 @@ describe('unit-d:types/OmitIndexSignature', () => {
       describe('T extends object', () => {
         it('should remove index signatures from T', () => {
           // Arrange
-          type T = string & { [x: string | symbol]: any }
+          type T = string & { [x: OwnPropertyKey]: any }
           type Expect = Omit<Objectify<T>, PropertyKey>
 
           // Expect

src/types/__tests__/property-key-own.spec-d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Type Tests - OwnPropertyKey
+ * @module tutils/types/tests/unit-d/OwnPropertyKey
+ */
+
+import type TestSubject from '../property-key-own'
+
+describe('unit-d:types/OwnPropertyKey', () => {
+  it('should extract string', () => {
+    expectTypeOf<TestSubject>().extract<string>().not.toBeNever()
+  })
+
+  it('should extract symbol', () => {
+    expectTypeOf<TestSubject>().extract<symbol>().not.toBeNever()
+  })
+})

src/types/__tests__/spread.spec-d.ts

@@ -13,6 +13,7 @@ import type Numeric from '../numeric'
 import type Objectify from '../objectify'
 import type { tag as opaque } from '../opaque'
 import type Optional from '../optional'
+import type OwnPropertyKey from '../property-key-own'
 import type TestSubject from '../spread'
 import type Writable from '../writable'
 
@@ -34,10 +35,10 @@ describe('unit-d:types/Spread', () => {
   })
 
   describe('IsAny<T> extends true', () => {
-    it('should equal { [x: string | symbol]: T }', () => {
+    it('should equal { [x: OwnPropertyKey]: T }', () => {
       // Arrange
       type T = any
-      type Expect = { [x: string | symbol]: T }
+      type Expect = { [x: OwnPropertyKey]: T }
 
       // Expect
       expectTypeOf<TestSubject<T>>().toEqualTypeOf<Expect>()
@@ -53,9 +54,9 @@ describe('unit-d:types/Spread', () => {
     })
 
     describe('IsEqual<T, object> extends true', () => {
-      it('should equal { [x: string | symbol]: any }', () => {
+      it('should equal { [x: OwnPropertyKey]: any }', () => {
         // Arrange
-        type Expect = { [x: string | symbol]: any }
+        type Expect = { [x: OwnPropertyKey]: any }
 
         // Expect
         expectTypeOf<TestSubject<object>>().toEqualTypeOf<Expect>()

src/types/index.ts

@@ -159,6 +159,7 @@ export type { default as Predicate } from './predicate'
 export type { default as Primitive } from './primitive'
 export type { default as Promisable } from './promisable'
 export type { default as PropertyKey } from './property-key'
+export type { default as OwnPropertyKey } from './property-key-own'
 export type { default as NaturalRange } from './range-natural'
 export type { default as Remap } from './remap'
 export type { default as Reverse } from './reverse'

src/types/object-plain.ts

@@ -4,14 +4,15 @@
  */
 
 import type Primitive from './primitive'
+import type OwnPropertyKey from './property-key-own'
 
 /**
  * A plain old JavaScript object (POJO).
  *
  * @see https://masteringjs.io/tutorials/fundamentals/pojo
  */
 type ObjectPlain = {
-  [x: string | symbol]: Primitive | object
+  [x: OwnPropertyKey]: Primitive | object
   readonly [Symbol.hasInstance]?: never
 }
 

src/types/omit-index-signature.ts

@@ -12,10 +12,10 @@ import type Objectify from './objectify'
  * @example
  *  type X = OmitIndexSignature<{
  *    [x: Numeric]: number
+ *    [x: OwnPropertyKey]: bigint
  *    [x: Stringify<bigint>]: bigint
- *    [x: number]: number
- *    [x: string | symbol]: any
  *    [x: `data.${string}`]: string
+ *    [x: number]: number
  *    hello: 'world'
  *    foo?: 'bar'
  *  }>

src/types/property-key-own.ts

@@ -0,0 +1,18 @@
+/**
+ * @file Type Definitions - OwnPropertyKey
+ * @module tutils/types/OwnPropertyKey
+ */
+
+import type PropertyKey from './property-key'
+
+/**
+ * An own property key.
+ *
+ * The own properties of an object are those that are defined directly on that
+ * object, and are not inherited from the object's prototype.
+ *
+ * @see {@linkcode PropertyKey}
+ */
+type OwnPropertyKey = Exclude<PropertyKey, number>
+
+export type { OwnPropertyKey as default }

src/types/property-key.ts

@@ -6,8 +6,8 @@
 import type NumberString from './number-string'
 
 /**
- * Property key types.
+ * A property key.
  */
-type PropertyKey = NumberString | symbol
+type PropertyKey = Extract<NumberString | symbol, any>
 
 export type { PropertyKey as default }

src/types/spread.ts

@@ -15,6 +15,7 @@ import type Keyof from './keyof'
 import type Length from './length'
 import type Objectify from './objectify'
 import type Primitive from './primitive'
+import type OwnPropertyKey from './property-key-own'
 import type Split from './split'
 import type Stringify from './stringify'
 import type Writable from './writable'
@@ -41,9 +42,9 @@ type Spread<T> = IsNever<T> extends true
   : T extends unknown
   ? Objectify<
       IsAny<T> extends true
-        ? Record<string | symbol, T>
+        ? Record<OwnPropertyKey, T>
         : IsEqual<T, object> extends true
-        ? Record<string | symbol, any>
+        ? Record<OwnPropertyKey, any>
         : T extends string
         ? Split<T, EmptyString>
         : T extends Primitive

src/utils/assign-with.ts

@@ -3,7 +3,13 @@
  * @module tutils/utils/assignWith
  */
 
-import type { Assign, Fn, ObjectCurly, Objectify } from '#src/types'
+import type {
+  Assign,
+  Fn,
+  ObjectCurly,
+  Objectify,
+  OwnPropertyKey
+} from '#src/types'
 import cast from './cast'
 import clone from './clone'
 import define from './define'
@@ -15,10 +21,10 @@ import properties from './properties'
  *
  * @param {any} outgoing - Outgoing property value
  * @param {any} incoming - Incoming property value from source object
- * @param {string | symbol} key - Current property key
+ * @param {OwnPropertyKey} key - Current property key
  * @return {any} New property value
  */
-type AssignCustomizer = Fn<[any, any, string | symbol]>
+type AssignCustomizer = Fn<[any, any, OwnPropertyKey]>
 
 /**
  * Assigns own properties of one or more `source` objects to a target object.

src/utils/equal.ts

@@ -7,6 +7,7 @@ import type {
   Fn,
   Nilable,
   Objectify,
+  OwnPropertyKey,
   PropertyKey,
   TypedArray
 } from '#src/types'
@@ -57,9 +58,9 @@ const equal = <T, U, H = PropertyKey>(
    * Returns an array containing own properties.
    *
    * @param {Objectify<any>} obj - Target object
-   * @return {(string | symbol)[]} Own properties array
+   * @return {OwnPropertyKey[]} Own properties array
    */
-  const owned = (obj: Objectify<any>): (string | symbol)[] => {
+  const owned = (obj: Objectify<any>): OwnPropertyKey[] => {
     return [
       ...Object.getOwnPropertySymbols(obj),
       ...Object.getOwnPropertyNames(obj)
@@ -154,9 +155,9 @@ const equal = <T, U, H = PropertyKey>(
     /**
      * Own properties of {@linkcode a}.
      *
-     * @const {(string | symbol)[]} properties
+     * @const {OwnPropertyKey[]} properties
      */
-    const properties: (string | symbol)[] = owned(a)
+    const properties: OwnPropertyKey[] = owned(a)
 
     // compare property values
     switch (true) {

src/utils/ksort.ts

@@ -4,7 +4,12 @@
  */
 
 import type { PropertyDescriptor } from '#src/interfaces'
-import type { Nilable, ObjectCurly, Objectify } from '#src/types'
+import type {
+  Nilable,
+  ObjectCurly,
+  Objectify,
+  OwnPropertyKey
+} from '#src/types'
 import alphabetize from './alphabetize'
 import cast from './cast'
 import define from './define'
@@ -96,9 +101,9 @@ const ksort = <T extends Objectify<any>>(
     /**
      * Property names mapped to property descriptors.
      *
-     * @const {[string | symbol,  PropertyDescriptor][]}
+     * @const {[OwnPropertyKey,  PropertyDescriptor][]}
      */
-    const props: [string | symbol, PropertyDescriptor][] = [
+    const props: [OwnPropertyKey, PropertyDescriptor][] = [
       ...alphabetize(Object.getOwnPropertyNames(object), identity, options),
       ...Object.getOwnPropertySymbols(object)
     ].map(key => [key, descriptor(object, key)])

src/utils/merge-with.ts

@@ -3,7 +3,13 @@
  * @module tutils/utils/mergeWith
  */
 
-import type { Fn, Merge, ObjectCurly, Objectify } from '#src/types'
+import type {
+  Fn,
+  Merge,
+  ObjectCurly,
+  Objectify,
+  OwnPropertyKey
+} from '#src/types'
 import cast from './cast'
 import clone from './clone'
 import define from './define'
@@ -16,10 +22,10 @@ import properties from './properties'
  *
  * @param {any} outgoing - Outgoing property value
  * @param {any} incoming - Incoming property value from source object
- * @param {string | symbol} key - Current property key
+ * @param {OwnPropertyKey} key - Current property key
  * @return {any} New property value
  */
-type MergeCustomizer = Fn<[any, any, string | symbol]>
+type MergeCustomizer = Fn<[any, any, OwnPropertyKey]>
 
 /**
  * Recursively merges own properties of one or more `source` objects into a

src/utils/overwrite-with.ts

@@ -3,7 +3,7 @@
  * @module tutils/utils/overwriteWith
  */
 
-import type { Fn, ObjectCurly, Overwrite } from '#src/types'
+import type { Fn, ObjectCurly, Overwrite, OwnPropertyKey } from '#src/types'
 import cast from './cast'
 import clone from './clone'
 import define from './define'
@@ -16,10 +16,10 @@ import properties from './properties'
  *
  * @param {any} outgoing - Outgoing property value
  * @param {any} incoming - Incoming property value from source object
- * @param {string | symbol} key - Current property key
+ * @param {OwnPropertyKey} key - Current property key
  * @return {any} New property value
  */
-type OverwriteCustomizer = Fn<[any, any, string | symbol]>
+type OverwriteCustomizer = Fn<[any, any, OwnPropertyKey]>
 
 /**
  * Assigns own properties from one or more `source` objects to a destination

src/utils/properties.ts

@@ -3,7 +3,12 @@
  * @module tutils/utils/properties
  */
 
-import type { Nilable, PropertyKey, Stringify } from '#src/types'
+import type {
+  Nilable,
+  OwnPropertyKey,
+  PropertyKey,
+  Stringify
+} from '#src/types'
 import cast from './cast'
 import enumerable from './enumerable'
 import type PropertiesOptions from './properties.options'
@@ -14,7 +19,9 @@ import select from './select'
  *
  * @template K - Property key type
  */
-type Properties<K extends PropertyKey> = K extends symbol ? K : Stringify<K>
+type Properties<K extends PropertyKey> = K extends OwnPropertyKey
+  ? K
+  : Stringify<K>
 
 /**
  * Returns an array containing own properties of a given target value.