RefInspector v1.0.0 RefInspector.Downloader View Source

Fetches copies of the configured database file(s).

All files will be stored in the configured database path with the default setting being the result of Application.app_dir(:ref_inspector, "priv").

Please consult RefInspector.Config for details on database configuration.

Mix Task

Please see Mix.Tasks.RefInspector.Download if you are interested in using a mix task to obtain your database file(s).

Link to this section Summary

Functions

Performs the download of the configured database files

Returns the local path to store a configured database at

Returns the remote path to download a configured database from

Reads a remote file and returns it’s contents

Link to this section Functions

Link to this function download() View Source
download() :: :ok

Performs the download of the configured database files.

Link to this function path_local(remote) View Source
path_local({String.t(), String.t()} | String.t()) :: String.t()

Returns the local path to store a configured database at.

Link to this function path_remote(remote) View Source
path_remote({String.t(), String.t()} | String.t()) :: String.t()

Returns the remote path to download a configured database from.

Link to this function read_remote(path) View Source
read_remote(String.t()) :: term()

Reads a remote file and returns it’s contents.