effect-io-ai

Package: effect
Module: SchemaGetter

SchemaGetter.collectBracketPathEntries

Flattens a nested object into bracket-path entries, filtering leaf values by a type guard.

When to use

Use when you need a schema getter to serialize structured objects to flat key-value entries.

• Building custom FormData or URLSearchParams encoders.

Details

• Takes a nested object and produces flat [bracketPath, value] pairs suitable for FormData or URLSearchParams.
• Returns a curried function: first call provides the leaf type guard, second call provides the object.
• Recursively traverses objects and arrays.
• If all elements of an array are leaves, encodes them as multiple entries with the same key (e.g. tags=a&tags=b). Otherwise uses indexed bracket paths (e.g. items[0], items[1]).
• Non-leaf values that aren’t objects or arrays are silently skipped.
• Empty arrays and objects produce no entries, and path delimiters in property names are not escaped. The resulting format is therefore lossy.

Example (Flattening an object to bracket paths)

import { Predicate, SchemaGetter } from "effect"

const collectStrings = SchemaGetter.collectBracketPathEntries(Predicate.isString)
const entries = collectStrings({ user: { name: "Alice", tags: ["admin", "editor"] } })
// [["user[name]", "Alice"], ["user[tags]", "admin"], ["user[tags]", "editor"]]

See

• makeTreeRecord for building trees from bracket-path entries
• encodeFormData for a higher-level FormData encoder
• encodeURLSearchParams for a higher-level URLSearchParams encoder

Signature

declare const collectBracketPathEntries: <A>(isLeaf: (value: unknown) => value is A) => (input: object) => Array<[bracketPath: string, value: A]>

Source

Since v4.0.0