Skip to main content

renderCommit

@webda/versioning


Function: renderCommit()

renderCommit(base, vp, options?): string

Defined in: packages/versioning/src/render.ts:85

Render a VersionedPatch as a git-commit-style view: a header with the commit id, author, timestamp, and message, followed by the unified diff produced by renderPatch().

Parameters​

base​

unknown

the "before" object

vp​

VersionedPatch

the versioned patch (as produced by commit() or wrap())

options?​

RenderOptions = {}

passed through to renderPatch

Returns​

string

formatted string (always ends with a newline when non-empty)