IzumiSy/elm-firestore/13.0.0

Firestore.Encode

Encoders for Firestore

type Encoder

An encoder consisted of Firestore specific encoders.

This can be encoded into Json.Value through encode function.

encode : Encoder -> Value

Generates Json.Encode.Value from Encoder

Constructors

type Builder

A builder for Firestore encoders}

Json.Encode.Value can be generated from this through build function.

Initializes a new builder for encoders

Firestore.Encode.new
    |> Firestore.Encode.field "name" (Firestore.Encode.string "stringValue")
    |> Firestore.Encode.field "age" (Firestore.Encode.int 10)
    |> Firestore.Encode.build
field : String -> Field b -> Builder -> Builder

A function to define document fields in a builder

type Field a

A field identifier type for Firestore encoder

Generates an encoder from an instance of Builder

Types

bool : Bool -> Field Bool
bytes : String -> Field Bytes
int : Int -> Field Int
string : String -> Field String
list : (a -> Field (CanBeListElement b)) -> List a -> Field List
dict : (a -> Field b) -> Dict String a -> Field Dict
null : Field Null
maybe : (a -> Field b) -> Maybe a -> Field Maybe
timestamp : Posix -> Field Timestamp
geopoint : Geopoint -> Field Geopoint
reference : Reference -> Field Reference