Data.Codec.JSON.Record

object :: forall ri ro rl. RowToList ri rl => RowListCodec rl ri ro => Record ri -> Codec (Record ro)

Constructs a Codec for a Record from a record of codecs.

type Person = { name ∷ String, age ∷ Int }

personCodec ∷ CJ.Codec Person
personCodec = CAR.object { name: CJ.string, age: CJ.int }

record :: forall ri ro rl. RowToList ri rl => RowListCodec rl ri ro => Record ri -> PropCodec (Record ro)

Constructs a JPropCodec for a Record from a record of codecs. Commonly the object function in this module will be the preferred choice, as that produces a Codec instead.

newtype Optional a

Used to wrap codec values provided in record to indicate the field is optional.

This will only decode the property as Nothing if the field does not exist in the object - having a values such as null assigned will need handling separately.

The property will be omitted when encoding and the value is Nothing.

Constructors

• Optional (Codec a)

Instances

• (RowListCodec rs ri' ro', Cons sym (Optional a) ri' ri, Cons sym (Maybe a) ro' ro, IsSymbol sym) => RowListCodec (Cons sym (Optional a) rs) ri ro

optional :: forall a. Codec a -> Optional a

A lowercase alias for Optional, provided for stylistic reasons only.

class RowListCodec :: RowList Type -> Row Type -> Row Type -> Constraintclass RowListCodec (rl :: RowList Type) (ri :: Row Type) (ro :: Row Type) | rl -> ri ro where

The class used to enable the building of Record codecs by providing a record of codecs.

Members

• rowListCodec :: forall proxy. proxy rl -> Record ri -> PropCodec (Record ro)

Instances

• RowListCodec Nil () ()
• (RowListCodec rs ri' ro', Cons sym (Optional a) ri' ri, Cons sym (Maybe a) ro' ro, IsSymbol sym) => RowListCodec (Cons sym (Optional a) rs) ri ro
• (RowListCodec rs ri' ro', Cons sym (Codec a) ri' ri, Cons sym a ro' ro, IsSymbol sym) => RowListCodec (Cons sym (Codec a) rs) ri ro