newtype overview

A port of newtype-ts to schemata-ts. Unliked branded types, newtypes are not assignable to the underlying type.

Schemata-ts uses Newtypes for UUIDs.

Added in v1.4.0

---

Table of contents

• Constructors
  • iso
• Model
  • Newtype (interface)
  • NewtypeIso (interface)
• Type Helpers
  • CarrierOf (type alias)
  • CombineURIs (type alias)
  • URIOf (type alias)

---

Constructors

iso

Signature

export declare const iso: <Nt extends Newtype<any, any>>() => NewtypeIso<Nt, CarrierOf<Nt>>

Added in v1.4.0

Model

Newtype (interface)

Represents a wrapped type that’s not assignable to its underlying type.

Signature

export interface Newtype<URI, A> {
  readonly _URI: URI
  readonly _A: A
}

Added in v1.4.0

NewtypeIso (interface)

Signature

export interface NewtypeIso<A, B> {
  readonly wrap: (B: B) => A
  readonly unwrap: (A: A) => B
}

Added in v2.0.0

Type Helpers

CarrierOf (type alias)

Signature

export type CarrierOf<N extends Newtype<any, any>> = N['_A']

Added in v1.4.0

CombineURIs (type alias)

Signature

export type CombineURIs<N1 extends Newtype<any, any>, N2 extends Newtype<any, CarrierOf<N1>>> = Newtype<
  URIOf<N1> & URIOf<N2>,
  CarrierOf<N1>
>

Added in v1.4.0

URIOf (type alias)

Signature

export type URIOf<N extends Newtype<any, any>> = N['_URI']

Added in v1.4.0