Packages

cereal

1.0.0

1.3.2 1.3.1 1.3.0 1.2.0 1.1.1 1.1.0 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0

A generalizable, configurable serialization dsl for elixir

HexDocs

Current section

Files

Jump to

Readme 11 Versions 2 Dependencies Dependants Files Activity

cereal README.md

Raw

README.md

# Cereal

Cereal is a Pluggable JSON Serialization layer. It allows you to define Serializers
to convert structs into an abstract format and then serialize those formats into JSON
in whichever way you wish.

## Features

* Customizable JSON serializer for entities and for errors
* Sparse fieldset support
* Dynamic include support
* `:has_one`, `:has_many`, `:embeds_one` relationships for your entities

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".