Skip to content

Latest commit

 

History

History
117 lines (74 loc) · 3.13 KB

couchbeam_deps.md

File metadata and controls

117 lines (74 loc) · 3.13 KB

Module couchbeam_deps

Function Index

deps_on_path/0List of project dependencies on the path.
ensure/0Ensure that the ebin and include paths for dependencies of this application are on the code path.
ensure/1Ensure that all ebin and include paths for dependencies of the application for Module are on the code path.
get_base_dir/0Return the application directory for this application.
get_base_dir/1Return the application directory for Module.
local_path/1Return an application-relative directory for this application.
local_path/2Return an application-relative directory from Module's application.
new_siblings/1Find new siblings paths relative to Module that aren't already on the code path.

Function Details

deps_on_path/0


deps_on_path() -> [ProjNameAndVers]

List of project dependencies on the path.

ensure/0


ensure() -> ok

Ensure that the ebin and include paths for dependencies of this application are on the code path. Equivalent to ensure(?Module).

ensure/1


ensure(Module) -> ok

Ensure that all ebin and include paths for dependencies of the application for Module are on the code path.

get_base_dir/0


get_base_dir() -> string()

Return the application directory for this application. Equivalent to get_base_dir(?MODULE).

get_base_dir/1


get_base_dir(Module) -> string()

Return the application directory for Module. It assumes Module is in a standard OTP layout application in the ebin or src directory.

local_path/1


local_path(Components) -> string()

Return an application-relative directory for this application. Equivalent to local_path(Components, ?MODULE).

local_path/2


local_path(Components::[string()], Module) -> string()

Return an application-relative directory from Module's application.

new_siblings/1


new_siblings(Module) -> [Dir]

Find new siblings paths relative to Module that aren't already on the code path.