Store (fnord v0.8.24)

View Source

Summary

Functions

Retrieves the currently selected project (specified with --project or via cwd) as a Store.Project.t. If unset, returns {:error, :project_not_set}.

Returns an ok tuple with a Store.Project.t, identified either by name or by simply passing through a Store.Project.t instance. If passed nil, it attempts to use the currently selected project (specified with --project or via cwd).

Functions

get_project()

@spec get_project() ::
  {:ok, Store.Project.t()}
  | {:error, :project_not_found}
  | {:error, :project_not_set}

Retrieves the currently selected project (specified with --project or via cwd) as a Store.Project.t. If unset, returns {:error, :project_not_set}.

get_project(project)

@spec get_project(nil | binary() | Store.Project.t()) ::
  {:ok, Store.Project.t()}
  | {:error, :project_not_found}
  | {:error, :project_not_set}

Returns an ok tuple with a Store.Project.t, identified either by name or by simply passing through a Store.Project.t instance. If passed nil, it attempts to use the currently selected project (specified with --project or via cwd).

store_home()

@spec store_home() :: binary()