effect-io-ai

Package: effect
Module: SchemaTransformation

SchemaTransformation.fromURLSearchParams

Decodes URLSearchParams into a nested record using bracket-path keys and encodes object-like values back into URLSearchParams.

When to use

Use when you need a schema transformation for query strings whose keys, such as filter[name] or items[0], should become nested data.

Details

Decode produces string leaves. Encode flattens nested objects and arrays into bracket-path entries and returns empty URLSearchParams for non-object inputs.

Example (Decoding URLSearchParams)

import { Schema, SchemaTransformation } from "effect"

const schema = Schema.instanceOf(URLSearchParams).pipe(
  Schema.decodeTo(Schema.Unknown, SchemaTransformation.fromURLSearchParams)
)

See

Signature

declare const fromURLSearchParams: Transformation<unknown, URLSearchParams, never, never>

Source

Since v4.0.0