feat: Add Struct.entries (#5237)

Co-authored-by: Giulio Canti <giulio.canti@gmail.com>

Author: 2 people

.changeset/curvy-sloths-tickle.md

@@ -0,0 +1,5 @@
+---
+"effect": minor
+---
+
+Add `Struct.entries` function

packages/effect/dtslint/Struct.tst.ts

@@ -328,4 +328,15 @@ describe("Struct", () => {
         .type.toBe<{ [x: `a${string}`]: number }>()
     })
   })
+
+  describe("entries", () => {
+    it("excludes symbol keys", () => {
+      const c = Symbol("c")
+      const value = { a: "a", b: 1, [c]: 2 }
+      // should not include symbol keys
+      expect(Struct.entries(value)).type.toBe<Array<["a" | "b", string | number]>>()
+      // when the object is passed as a parameter, the values should be narrowed
+      expect(Struct.entries({ a: "a", b: 1, [c]: 2 })).type.toBe<Array<["a" | "b", "a" | 1]>>()
+    })
+  })
 })

packages/effect/src/Struct.ts

@@ -219,3 +219,25 @@ export const get =
  * @since 3.6.0
  */
 export const keys = <T extends {}>(o: T): Array<(keyof T) & string> => Object.keys(o) as Array<(keyof T) & string>
+
+/**
+ * Retrieves the entries (key-value pairs) of an object, where keys are strings,
+ * in a type-safe manner. Symbol keys are excluded from the result.
+ *
+ * @example
+ * ```ts
+ * import * as assert from "node:assert"
+ * import { Struct } from "effect"
+ *
+ * const c = Symbol("c")
+ * const value = { a: "foo", b: 1, [c]: true }
+ *
+ * const entries: Array<["a" | "b", string | number]> = Struct.entries(value)
+ *
+ * assert.deepStrictEqual(entries, [["a", "foo"], ["b", 1]])
+ * ```
+ *
+ * @since 3.17.0
+ */
+export const entries = <const R>(obj: R): Array<[keyof R & string, R[keyof R & string]]> =>
+  Object.entries(obj as any) as any

packages/effect/test/Struct.test.ts

@@ -120,4 +120,10 @@ describe("Struct", () => {
     strictEqual(pipe({ a: 1 }, Struct.get("a")), 1)
     strictEqual(pipe({}, Struct.get("a")), undefined)
   })
+
+  it("entries", () => {
+    const c = Symbol("c")
+    // should not include symbol keys
+    deepStrictEqual(Struct.entries({ a: "a", b: 1, [c]: 2 }), [["a", "a"], ["b", 1]])
+  })
 })