Hyperlinkv0.8.0-beta.28

Struct

Struct.getconsteffect/Struct.ts:135
<S extends object, const K extends keyof S>(key: K): (self: S) => S[K]
<S extends object, const K extends keyof S>(self: S, key: K): S[K]

Retrieves the value at key from a struct.

When to use

Use to extract a single property from a struct in a pipeline.

Details

The return type is narrowed to S[K].

Example (Extracting a property in a pipeline)

import { pipe, Struct } from "effect"

const name = pipe({ name: "Alice", age: 30 }, Struct.get("name"))
console.log(name) // "Alice"
getterskeyspick
Source effect/Struct.ts:1354 lines
export const get: {
  <S extends object, const K extends keyof S>(key: K): (self: S) => S[K]
  <S extends object, const K extends keyof S>(self: S, key: K): S[K]
} = dual(2, <S extends object, const K extends keyof S>(self: S, key: K): S[K] => self[key])