CasefileKeeper

git-casefile. CasefileKeeper

new CasefileKeeper(kwargsopt)

Class for managing casefiles

Source:
Properties:
Name Type Description
bookmarks BookmarkFacilitator
gitOps GitInteraction

Use an instance of this class to both manage bookmark instances (through its bookmarks property) and to access the shared casefile library(ies) of configured remotes.

While casefiles shared to remotes are generally expected to conform to the Casefile type, there is no requirement they do so...only that they are Objects supporting JSON.stringify.

Parameters:
Name Type Attributes Description
kwargs object <optional>

Keyword arguments; passed through to construct a BookmarkFacilitator

Properties
Name Type Attributes Description
gitOps GitInteraction <optional>

Alternate implementation of Git operations
runGitCommand ToolkitRunnerFunc <optional>

Alternate command runner for executing git program used to construct a GitInteraction object if kwargs.gitOps is not given
toolOptions object <optional>

Options used to construct a ToolkitRunnerFunc for git if neither kwargs.gitOps nor kwargs.runGitCommand are given

Methods

(async) getCasefiles() → {Promise.<Array.<CasefileGroup>>}

Get CasefileGroup objects for known casefiles

Source:
Returns:
Type
Promise.<Array.<CasefileGroup>>

(async) getDeletedCasefileRefs(partialopt) → {Promise.<Array.<DeletedCasefileRef>>}

Get references to deleted casefiles (possibly filtered)

Source:
Parameters:
Name Type Attributes Description
partial string <optional>
Returns:
Type
Promise.<Array.<DeletedCasefileRef>>

(async) getRemotes() → {Promise.<Array.<GitRemote>>}

Get an Array of GitRemote objects for all configured remotes

Source:
Returns:
Type
Promise.<Array.<GitRemote>>

remote(name) → {GitRemote}

Get a GitRemote for a given name

Source:
Parameters:
Name Type Description
name string

Name of the remote
Returns:

A new GitRemote object for name

Type
GitRemote