friendly_id/generator

Types

Generator

opaque </>

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 opaque type Generator

GeneratorError

</>

pub type GeneratorError {
  NegativePredicateCount
}

Constructors

```
NegativePredicateCount
```

Values

get_obj_multiplier

</>

pub fn get_obj_multiplier(generator: Generator) -> Int

get_objects

</>

pub fn get_objects(
  generator: Generator,
) -> glearray.Array(String)

get_pred_multiplier

</>

pub fn get_pred_multiplier(generator: Generator) -> Int

get_predicate_count

</>

pub fn get_predicate_count(generator: Generator) -> Int

get_predicates

</>

pub fn get_predicates(
  generator: Generator,
) -> glearray.Array(String)

get_separator

</>

pub fn get_separator(generator: Generator) -> String

get_transform_fn

</>

pub fn get_transform_fn(
  generator: Generator,
) -> fn(String) -> String

new

</>

pub fn new() -> Generator

Create a Generator record with the following defaults:

Predicate count: 1
No separator
No transformation
Provided word lists

Examples

let generator = generator.new()

new_with_words

</>

pub fn new_with_words(
  objects objects: glearray.Array(String),
  predicates predicates: glearray.Array(String),
) -> Generator

Create a Generator record with the word lists passed to it and the following defaults:

Predicate count: 1
No separator
No transformation

Examples

let objects = glearray.from_list(["apple, potato"])
let predicates = glearray.from_list(["brave, insightful"])
let generator = generator.new_with_words(objects:, predicates:)

set_predicate_count

</>

pub fn set_predicate_count(
  generator: Generator,
  predicate_count: Int,
) -> Result(Generator, GeneratorError)

set_separator

</>

pub fn set_separator(
  generator: Generator,
  separator: String,
) -> Generator

set_transform_fn

</>

pub fn set_transform_fn(
  generator: Generator,
  transform_fn: fn(String) -> String,
) -> Generator