grgit-resolve

Name

grgit-resolve - Resolves objects to various types

Synopsis

grgit.resolve.toObjectId(<object>)
grgit.resolve.toCommit(<object>)
grgit.resolve.toBranch(<object>)
grgit.resolve.toBranchName(<object>)
grgit.resolve.toTag(<object>)
grgit.resolve.toTagName(<object>)
grgit.resolve.toRevisionString(<object>)

Description

Various methods to resolve objects to types needed by Grgit operations. These are used to normalize the input, allowing the caller more flexibility in providing the data they have rather than having to convert it ahead of time.

Options

toObjectId

Accepts Commit, Tag, Branch, Ref

toCommit

Accepts Commit, Tag, Branch, String, GString

toBranch

Accepts Branch, String, GString

toBranchName

Accepts Branch, String, GString

toTag

Accepts Tag, String, GString

toTagName

Accepts Tag, String, GString

toRevisionString

Accepts Commit, Tag, Branch, String, GString

Examples

See Also