feat: new function - isKeyOf

Author: GreatAuk

README.md

@@ -165,6 +165,7 @@ pnpm add @utopia-utils/share
 * isValidUrl  [source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/isValidUrl.ts)
 * isPositiveNumber  [source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/isPositiveNumber.ts)
 * isNegativeNumber  [source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/isNegativeNumber.ts)
+* isKeyOf  [source](https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/isKeyOf.ts)
 ------
 
 ### vendor

packages/core/src/yuanFormat.ts

@@ -4,7 +4,7 @@ import { fenToYuan } from './fenToYuan'
 
 interface Options {
   /**
-   * 单位，分或元, 如果单位是分，会自动转换为元再格式化
+   * 单位，分或元, 如果单位是分，则会将金额转换为元
    * @default 'fen'
    */
   unit?: 'fen' | 'yuan'

packages/share/src/index.ts

@@ -6,3 +6,4 @@ export * from './isPositiveNumber'
 export * from './isNegativeNumber'
 export * from './measurePerformance'
 export * from './utils'
+export * from './isKeyOf'

packages/share/src/isKeyOf.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it } from 'vitest'
+
+import { isKeyOf } from './isKeyOf'
+
+describe('isKeyOf', () => {
+  it('should return true when key exists in object', () => {
+    const obj = { a: 1, b: 2, c: 3 }
+    expect(isKeyOf(obj, 'a')).toBe(true)
+    expect(isKeyOf(obj, 'b')).toBe(true)
+    expect(isKeyOf(obj, 'c')).toBe(true)
+  })
+
+  it('should return false when key does not exist in object', () => {
+    const obj = { a: 1, b: 2, c: 3 }
+    expect(isKeyOf(obj, 'd')).toBe(false)
+    expect(isKeyOf(obj, 'e')).toBe(false)
+    expect(isKeyOf(obj, 'foo')).toBe(false)
+  })
+
+  it('should work with numeric keys', () => {
+    const obj = { 1: 'one', 2: 'two' }
+    expect(isKeyOf(obj, 1)).toBe(true)
+    expect(isKeyOf(obj, 2)).toBe(true)
+    expect(isKeyOf(obj, 3)).toBe(false)
+  })
+
+  it('should work with symbol keys', () => {
+    const symKey = Symbol('key')
+    const obj = { [symKey]: 'value' }
+    expect(isKeyOf(obj, symKey)).toBe(true)
+    expect(isKeyOf(obj, Symbol('another'))).toBe(false)
+  })
+
+  it('should work with inherited properties', () => {
+    const proto = { a: 1 }
+    const obj = Object.create(proto)
+    obj.b = 2
+
+    expect(isKeyOf(obj, 'a')).toBe(true)
+    expect(isKeyOf(obj, 'b')).toBe(true)
+    expect(isKeyOf(obj, 'toString')).toBe(true)
+  })
+})

packages/share/src/isKeyOf.ts

@@ -0,0 +1,18 @@
+/**
+ * Type guard for any key, `k`.
+ * Marks `k` as a key of `T` if `k` is in `obj`.
+ *
+ * @category Object
+ * @param obj object to query for key `k`
+ * @param k key to check existence in `obj`
+ * @example
+ * ```ts
+ * const obj = { a: 1, b: 2 }
+ * const k = 'a'
+ * const isKey = isKeyOf(obj, k) // true
+ * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/isKeyOf.ts
+ */
+export function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T {
+  return k in obj
+}

packages/share/src/isNegativeNumber.ts

@@ -11,6 +11,7 @@ import { isNumber } from './is'
  * isNegativeNumber('1') // false
  * isNegativeNumber('-1') // true
  * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/isNegativeNumber.ts
  */
 export function isNegativeNumber(val: unknown): boolean {
   return isNumber(val) && val < 0

packages/share/src/measurePerformance.ts

@@ -1,4 +1,15 @@
 /* eslint-disable no-console */
+
+/**
+ * Measure the performance of a function
+ * @example
+ * ```ts
+ * const time = measurePerformance(this, () => {
+ *   // function body
+ * }, arg1, arg2)
+ * ```
+ * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/share/src/measurePerformance.ts
+ */
 export function measurePerformance<T extends (...args: any[]) => any>(this: ThisParameterType<T>, fn: T, ...args: Parameters<T>): number {
   const start = performance.now()
   fn.call(this, ...args)