Literature.StaticPages.Helpers (literature v0.4.17)

Provides helper functions for the static pages generator in Literature.

Summary

async_opt()

async_task()

Wrapper around Task.async_stream/3 to returns only the result of the task

Checks if the given module has the specified template function. Raises an error if the template is not found.

@type async_opt() ::
  {:timeout, timeout()}
  | {:ordered, boolean()}
  | {:max_concurrency, integer()}
  | {:flatten, boolean()}

@type async_task() :: {module(), atom(), [any()]}

@spec async!(Enumerable.t(), (term() -> term()), [async_opt()]) :: [term()]

Wrapper around Task.async_stream/3 to returns only the result of the task

@spec check_for_template!(module(), atom()) :: :ok

Checks if the given module has the specified template function. Raises an error if the template is not found.

@spec format_result(
  :ok | {:ok, tuple()} | {:error, term()},
  String.t(),
  String.t()
) :: :ok | {:ok, list()}

@spec get_author!(String.t(), String.t()) :: Literature.Author.t()

@spec get_post!(String.t(), String.t()) :: Literature.Post.t()

@spec get_publication!(String.t()) :: Literature.Publication.t()

@spec get_tag!(String.t(), String.t()) :: Literature.Tag.t()

@spec paginate_published_posts(String.t(), integer(), integer(), map()) ::
  Literature.Pagination.Page.t()