IzumiSy/elm-firestore/10.0.0

NOTE: the latest version is 13.0.0

Firestore.Config

A configuration type for Firestore

type Config

Data type for Firestore configuration

This type internally has all information which is required to send requests to Firestore through REST API.

Constructors

new :
{ apiKey : String
, project : String
}
-> Config

Creates a new Config

Specifies Firebase Authorization token which can be obtained through firebase.User#getIdToken method.

withDatabase : String -> Config -> Config

Specifies database ID to connect to.

withHost : String -> Int -> Config -> Config

Specifies host and port to connect to.

This function is useful when you write integration tests using mock servers such as Firestore Emulator.

Extractors

endpoint : List QueryParameter -> Appender -> Config -> String

Builds an endpoint string

= Path String
| Op String

Encpoint appender

httpHeader : Config -> List Header

Extracts authorization with bearer prefix as Http.Header.

basePath : Config -> String

Builds a path that can be used in a document name