Aura.Model.Common (Aura v0.9.1)

View Source

Common capabilities across all Aura models

๐Ÿ“– Resources

Summary

Types

URL with human-readable package/release documentation

URL with human-readable package/release information

DateTime for when the record was inserted into the database

DateTime for when the record was last modified in the database

The URL required to perform operations on this record

Functions

Cleans and validates a map into something Aura models can easily build

Types

docs_html_url()

@type docs_html_url() :: URI.t()

URL with human-readable package/release documentation

๐Ÿ’ป Examples

"https://hexdocs.pm/aura/0.9.0/"

html_url()

@type html_url() :: URI.t()

URL with human-readable package/release information

๐Ÿ’ป Examples

"https://hex.pm/packages/aura/0.9.0"

inserted_at()

@type inserted_at() :: DateTime.t()

DateTime for when the record was inserted into the database

๐Ÿ’ป Examples

~U[2025-05-29 18:15:18.244790Z]

updated_at()

@type updated_at() :: DateTime.t()

DateTime for when the record was last modified in the database

๐Ÿ’ป Examples

~U[2025-06-01 15:13:04.347130Z]

url()

@type url() :: URI.t()

The URL required to perform operations on this record

๐Ÿ’ป Examples

"https://hex.pm/api/packages/aura/releases/0.9.0"

Functions

prepare(m)

@spec prepare(m :: map()) :: list()

Cleans and validates a map into something Aura models can easily build

๐Ÿท๏ธ Params

  • m :: A map to clean and validate

โคต๏ธ Returns

โœ… On Success

  [{k,v}, {k,v}...]

โŒ On Failure

  raises Error