Refinement overview

Added in v2.11.0

---

Table of contents

• constructors
  • id
• lifting
  • fromEitherK
  • fromOptionK
• utils
  • Refinement (interface)
  • and
  • compose
  • not
  • or
  • zero

---

constructors

id

Signature

export declare const id: <A>() => Refinement<A, A>

Added in v2.11.0

lifting

fromEitherK

Signature

export declare const fromEitherK: <A, B extends A>(getEither: (a: A) => Either<unknown, B>) => Refinement<A, B>

Added in v2.11.0

fromOptionK

Returns a Refinement from a Option returning function. This function ensures that a Refinement definition is type-safe.

Signature

export declare const fromOptionK: <A, B extends A>(getOption: (a: A) => Option<B>) => Refinement<A, B>

Added in v2.11.0

utils

Refinement (interface)

Signature

export interface Refinement<A, B extends A> {
  (a: A): a is B
}

Added in v2.11.0

and

Signature

export declare const and: <A, C extends A>(
  second: Refinement<A, C>
) => <B extends A>(first: Refinement<A, B>) => Refinement<A, B & C>

Added in v2.11.0

compose

Signature

export declare const compose: <A, B extends A, C extends B>(
  bc: Refinement<B, C>
) => (ab: Refinement<A, B>) => Refinement<A, C>

Added in v2.11.0

not

Signature

export declare const not: <A, B extends A>(refinement: Refinement<A, B>) => Refinement<A, Exclude<A, B>>

Added in v2.11.0

or

Signature

export declare const or: <A, C extends A>(
  second: Refinement<A, C>
) => <B extends A>(first: Refinement<A, B>) => Refinement<A, C | B>

Added in v2.11.0

zero

Signature

export declare const zero: <A, B extends A>() => Refinement<A, B>

Added in v2.11.0