forage v0.4.0

API Reference forage v0.4.0

Modules

Forage

Documentation for Forage.

Forage.AssocLoader
Forage.Codec.Decoder

Functionality to decode a Phoenix params map into a form suitable for use with the query builders and pagination libraries

Forage.Codec.Encoder

Functionality to encode a Forage.Plan into a Phoenix param map for use with the ApplicationWeb.Router.Helpers.

Forage.Codec.Exceptions.InvalidAssocError
Forage.Codec.Exceptions.InvalidFieldError
Forage.Codec.Exceptions.InvalidPaginationDataError
Forage.Codec.Exceptions.InvalidSortDirectionError
Forage.ForagePlan

A forage plan, which can be used to run paginated queries on your repo.

Forage.Paginator
Forage.QueryBuilder.Filter.AddFilterToQuery
Forage.Search

Utilities to help with search

ForageWeb.Assets
ForageWeb.Display
ForageWeb.ForageController

Helper functions for Plug controllers that use forage.

ForageWeb.ForageView

Helper functions for vews that feature forage filters, pagination buttons or sort links.