friendly_id

Types

Generator

This record contains the objects and predicates arrays, needed to generate a friendly ID. Should only be initialized once, then passed as a dependency.

pub type Generator {
  Generator(
    objects: iv.Array(String),
    predicates: iv.Array(String),
    transform_fn: fn(String) -> String,
    separator: String,
  )
}

Constructors

Generator(
  objects: iv.Array(String),
  predicates: iv.Array(String),
  transform_fn: fn(String) -> String,
  separator: String,
)

Values

generate

</>

pub fn generate(generator: Generator) -> String

Generates a friendly ID from a Generator record.

Examples

Create a generator with an uppercase transform and a “_” separator, then generate an ID

let generator = new_generator(string.uppercase, "_")
echo generate(generator)

new_default_generator

</>

pub fn new_default_generator(separator: String) -> Generator

Create a Generator record with no transform function.

Examples

Create a generator with a “_” separator, then generate an ID

let generator = new_default_generator("_")
echo generate(generator)

new_generator

</>

pub fn new_generator(
  transform_fn: fn(String) -> String,
  separator: String,
) -> Generator

Create a Generator record with no transform function.

Examples

Create a generator with an uppercase transform and a “_” separator, then generate an ID

let generator = new_generator(string.uppercase, "_")
echo generate(generator)