Nf.Helper (neo_faker v0.5.0)

Provides utility functions commonly used across modules.

Summary

exs_path()

Path to the lib/data/ directory

get_data_path()

Returns the absolute path to the lib/data directory.

Reads an .exs script file from the lib/data directory and returns its contents as a map.

(since 0.4.1)

@type exs_path() :: [String.t()]

Path to the lib/data/ directory

(since 0.4.1)

@spec get_data_path() :: String.t()

Returns the absolute path to the lib/data directory.

This path is useful for loading dynamic files, such as .exs scripts.

(since 0.4.1)

@spec read_exs_file!(exs_path(), String.t()) :: map()

Reads an .exs script file from the lib/data directory and returns its contents as a map.