IzumiSy / elm-firestore / Firestore.Options.List

An option type for list operation.


type Options

An option type for List operation

default : Options

Constructs options for list operation

queryParameters : Options -> List Url.Builder.QueryParameter

Converts options into query parameters

Pagination


type PageToken
    = PageToken Firestore.Internals.PageToken

The next page token.

This token is required in fetching the next result offset by pageSize in list operation. The internal implementation is intetentionally encapsulated in order not to make invalid one by hand. It can be obtained only from Documents record.

pageToken : PageToken -> Options -> Options

Sets the page token obtained the previous List operation, if any.

pageSize : Basics.Int -> Options -> Options

Sets the maximum number of documents to return

OrderBy


type OrderBy
    = Desc String
    | Asc String

OrderBy direction and column

orderBy : OrderBy -> Options -> Options

Sets order to sort results by