OutputContract

OutputContract = { type: "raw"; } | { type: "porcelain"; version: 1 | 2; } | { type: "json"; } | { delimiter: string; nullTerminated?: boolean; type: "delimited"; } | { format: string; type: "pretty"; }

Defined in: src/core/types.ts:323

Output contract types for typed API

Typed API only supports commands with predictable output formats.

Type Declaration

{ type: "raw"; }

type

type: "raw"

Raw output - no parsing

{ type: "porcelain"; version: 1 | 2; }

type

type: "porcelain"

version

version: 1 | 2

Porcelain format (v1 or v2)

{ type: "json"; }

type

type: "json"

JSON output

{ delimiter: string; nullTerminated?: boolean; type: "delimited"; }

delimiter

delimiter: string

nullTerminated?

optional nullTerminated: boolean

type

type: "delimited"

Custom format with a specific delimiter

{ format: string; type: "pretty"; }

format

format: string

type

type: "pretty"

Custom pretty format for git log