struct overview

Added in v2.10.0


Table of contents


instances

getAssignSemigroup

Return a semigroup which works like Object.assign.

Signature

export declare const getAssignSemigroup: <A extends object = never>() => Semigroup<A>

Example

import { getAssignSemigroup } from 'fp-ts/struct'

interface Person {
  readonly name: string
  readonly age: number
}

const S = getAssignSemigroup<Person>()
assert.deepStrictEqual(S.concat({ name: 'name', age: 23 }, { name: 'name', age: 24 }), { name: 'name', age: 24 })

Added in v2.10.0

utils

evolve

Creates a new object by recursively evolving a shallow copy of a, according to the transformation functions.

Signature

export declare const evolve: <A, F extends { [K in keyof A]: (a: A[K]) => unknown }>(
  transformations: F
) => (a: A) => { [K in keyof F]: ReturnType<F[K]> }

Example

import { pipe } from 'fp-ts/function'
import { evolve } from 'fp-ts/struct'

assert.deepStrictEqual(
  pipe(
    { a: 'a', b: 1 },
    evolve({
      a: (a) => a.length,
      b: (b) => b * 2,
    })
  ),
  { a: 1, b: 2 }
)

Added in v2.11.0