✨ feat: get-keys #12 from use-kit/feat/fns

Author: AkashiGakki

packages/core/getFieldWithDefault/index.md

@@ -0,0 +1,16 @@
+---
+category: '@Core'
+---
+
+# getField
+
+Get object field with multiple default fields.
+
+## Usage
+
+```ts
+import { getFieldWithDefault } from '@use-kit/functions'
+
+const obj = { name: 'asuka', age: 23, height: 158 }
+const ret = getFieldWithDefault(obj, 'default', obj.id, obj.name, obj.nickname) // 'asuak'
+```

packages/core/getFieldWithDefault/index.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, it } from 'vitest'
+import { getFieldWithDefault } from '.'
+
+describe('getFieldWithDefault', () => {
+  it('default', () => {
+    const obj = { name: 'asuka', age: 23, height: 158 }
+    expect(getFieldWithDefault(
+      obj,
+      'defaultValue',
+      (obj as any)?.id,
+      obj?.name,
+      (obj as any)?.nickname,
+    )).toMatchInlineSnapshot('"defaultValue"')
+  })
+})

packages/core/getFieldWithDefault/index.ts

@@ -0,0 +1,20 @@
+interface ObjectWithFields { [key: string]: any }
+
+// TODO: get field with multiple default fields
+export function getFieldWithDefault<T>(
+  obj: ObjectWithFields,
+  defaultValue: T,
+  ...fields: string[]
+): T {
+  if (typeof obj !== 'object' || obj === null)
+    return defaultValue
+
+  console.log('fields', fields)
+  for (const field of fields) {
+    if (Reflect.has(obj, field))
+      return field as T
+  }
+  console.log('default')
+
+  return defaultValue
+}

packages/core/getKeys/index.md

@@ -0,0 +1,20 @@
+---
+category: '@Core'
+---
+
+# getKeys
+
+Get keys.
+
+## Usage
+
+```ts{6,7}
+import { getKeys } from '@use-kit/functions'
+
+const p = { name: 'asuka', age: 24 }
+const ret = getKeys(p)
+// [
+//   "name",
+//   "age",
+// ]
+```

packages/core/getKeys/index.test.ts

@@ -0,0 +1,25 @@
+import { describe, expect, it } from 'vitest'
+import { getKeys } from '.'
+
+describe('getKeys', () => {
+  it('get keys', () => expect(getKeys({ name: 'asuka', age: 24 })).toMatchInlineSnapshot(`
+    [
+      "name",
+      "age",
+    ]
+  `))
+
+  const map = new Map([
+    ['akashi', { id: 'akashi' }],
+    ['asuka', { id: 'asuka' }],
+  ])
+
+  it('get map keys', () => {
+    expect(getKeys(map)).toMatchInlineSnapshot(`
+      [
+        "akashi",
+        "asuka",
+      ]
+    `)
+  })
+})

packages/core/getKeys/index.ts

@@ -0,0 +1,14 @@
+import { isEmpty, isMap } from '..'
+
+export const getKeys = (
+  obj: object | Map<string, any> | null | undefined,
+): string[] => {
+  if (isEmpty(obj))
+    return []
+
+  if (isMap(obj))
+    return Array.from((obj as Map<string, any>).keys())
+
+  else
+    return Object.keys(obj as object)
+}

packages/core/getValues/index.md

@@ -8,6 +8,13 @@ Get values.
 
 ## Usage
 
-```ts
+```ts{6,7}
 import { getValues } from '@use-kit/functions'
+
+const p = { name: 'asuka', age: 24 }
+const ret = getValues(p)
+// [
+//   "asuka",
+//   24,
+// ]
 ```

packages/core/getValues/index.test.ts

@@ -1,5 +1,42 @@
 import { describe, expect, it } from 'vitest'
+import { getValues } from '.'
 
 describe('getField', () => {
-  it('get values', () => expect(true).toBeTruthy())
+  it('get values', () => expect(getValues({ name: 'asuka', age: 24 })).toMatchInlineSnapshot(`
+    [
+      "asuka",
+      24,
+    ]
+  `))
+
+  it('get string values', () => {
+    expect(getValues('akashi')).toMatchInlineSnapshot(`
+      [
+        "a",
+        "k",
+        "a",
+        "s",
+        "h",
+        "i",
+      ]
+    `)
+  })
+
+  const map = new Map([
+    ['akashi', { id: 'akashi' }],
+    ['asuka', { id: 'asuka' }],
+  ])
+
+  it('get map values', () => {
+    expect(getValues(map as any)).toMatchInlineSnapshot(`
+      [
+        {
+          "id": "akashi",
+        },
+        {
+          "id": "asuka",
+        },
+      ]
+    `)
+  })
 })

packages/core/getValues/index.ts

@@ -1,6 +1,19 @@
-export const getValues = <T>(object: { [key: string]: T } | null | undefined): T[] => {
-  if (object == null)
+import { isEmpty, isMap } from '..'
+
+interface GenericObject<T> {
+  [key: string]: T
+}
+
+export const getValues = <T>(object: {
+  [key: string]: T
+} | Map<string, T> | string | null | undefined): T[] => {
+  if (isEmpty(object))
     return []
 
-  return Object.keys(object).map(key => object[key])
+  if (isMap(object))
+    return Array.from((object as Map<string, T>).values())
+
+  return Object
+    .keys((object as GenericObject<T>))
+    .map(key => (object as GenericObject<T>)[key])
 }

packages/core/index.ts

@@ -13,8 +13,10 @@ export * from './getAge'
 export * from './getConstellation'
 export * from './getField'
 export * from './getFileType'
+export * from './getKeys'
 export * from './getObjectField'
 export * from './getTreeNode'
+export * from './getValues'
 
 export * from './hasField'
 export * from './hideMobile'