Packages

siren

2.3.0

2.3.3 2.3.2 2.3.1 2.3.0 2.2.0 2.1.0 2.0.0 1.0.0

Easy siren encoding for easy HATEOAS.

HexDocs

Current section

Files

Jump to

Readme 8 Versions 1 Dependency Dependants Files Activity

siren lib siren siren.ex

Raw

7 files

lib/siren/siren.ex

defprotocol Siren do
  def encode(payload, opts)
end

defimpl Siren, for: Atom do
  def encode(payload, _opts), do: payload
end

defimpl Siren, for: List do
  alias Siren.Collection

  def encode(payload, opts), do: Collection.encode(payload, opts)
end

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".