transformLiterals

Call Signature

transformLiterals<A>(…pairs): Union<{ -readonly [I in string | number | symbol]: transformLiteral<A[I<I>][1], A[I<I>][0]> }>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:2073

Creates a new Schema which maps between corresponding literal values.

Type Parameters

A

A extends readonly [readonly [LiteralValue, LiteralValue], readonly [LiteralValue, LiteralValue], readonly [LiteralValue, LiteralValue]]

Parameters

pairs

…A

Returns

Union<{ -readonly [I in string | number | symbol]: transformLiteral<A[I<I>][1], A[I<I>][0]> }>

Example

import * as assert from "node:assert"
import * as S from "effect/Schema"

const Animal = S.transformLiterals(
  [0, "cat"],
  [1, "dog"],
  [2, "cow"]
)

assert.deepStrictEqual(S.decodeSync(Animal)(1), "dog")

Since

3.10.0

Call Signature

transformLiterals<Encoded, Type>(pairs): transformLiteral<Type, Encoded>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:2076

Creates a new Schema which maps between corresponding literal values.

Type Parameters

Encoded

Encoded extends LiteralValue

Type

Type extends LiteralValue

Parameters

pairs

[Encoded, Type]

Returns

transformLiteral<Type, Encoded>

Example

import * as assert from "node:assert"
import * as S from "effect/Schema"

const Animal = S.transformLiterals(
  [0, "cat"],
  [1, "dog"],
  [2, "cow"]
)

assert.deepStrictEqual(S.decodeSync(Animal)(1), "dog")

Since

3.10.0

Call Signature

transformLiterals<A>(…pairs): Schema<A[number][1], A[number][0]>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:2077

Creates a new Schema which maps between corresponding literal values.

Type Parameters

A

A extends readonly readonly [LiteralValue, LiteralValue][]

Parameters

pairs

…A

Returns

Schema<A[number][1], A[number][0]>

Example

import * as assert from "node:assert"
import * as S from "effect/Schema"

const Animal = S.transformLiterals(
  [0, "cat"],
  [1, "dog"],
  [2, "cow"]
)

assert.deepStrictEqual(S.decodeSync(Animal)(1), "dog")

Since

3.10.0