Digger protocol (digger v3.1.0)

Copy Markdown

Documentation for Digger Protocol

Summary

Types

t()

All the types that implement this protocol.

Functions

'Atomize' a valid Types.data_type according to the protocol implementation

Camel case a valid Types.data_type according to the protocol implementation

'Dasherize' a valid Types.data_type according to the protocol implementation

Lower case first letter of a valid Types.data_type according to the protocol implementation

snake_case a valid Types.data_type according to the protocol implementation

'Stringify' a valid Types.data_type according to the protocol implementation

Upper case the first letter of a valid Types.data_type according to the protocol implementation

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

atomize(data_type, opts \\ [type: :key, key_transform: :atomize, value_transform: :none])

'Atomize' a valid Types.data_type according to the protocol implementation

By default, atomizing a string that has no corresponding existing atom creates a new one via String.to_atom/1, which is safe for trusted input but can exhaust the atom table if used on untrusted/external data (atoms are never garbage collected).

Pass existing: true to atomize via String.to_existing_atom/1 instead: strings that already have a matching atom are converted as usual, and strings that don't are left as the original string rather than raising or creating a new atom.

camel_case(data_type, opts \\ [type: :key, key_transform: :upper, value_transform: :none])

Camel case a valid Types.data_type according to the protocol implementation

dasherize(data_type, opts \\ [type: :key, key_transform: :dasherize, value_transform: :none])

'Dasherize' a valid Types.data_type according to the protocol implementation

lowercase_first(data_type, opts \\ [type: :key, key_transform: :lower, value_transform: :none])

Lower case first letter of a valid Types.data_type according to the protocol implementation

snake_case(data_type, opts \\ [type: :key, key_transform: :snake, value_transform: :none])

snake_case a valid Types.data_type according to the protocol implementation

stringify(data_type, opts \\ [type: :key, key_transform: :stringify, value_transform: :none])

'Stringify' a valid Types.data_type according to the protocol implementation

upcase_first(data_type, opts \\ [type: :key, key_transform: :upper, value_transform: :none])

Upper case the first letter of a valid Types.data_type according to the protocol implementation