git-wire

Import

Import

import * as api from "@fungi.computer/agar/git-wire";

Exports

Kind	Export	Description
Ttype alias	ReceivePack	The decoded receive-pack command section; pack bytes remain unopened.
fnfunction	readPacketLines()	Split pkt-lines from the start of bytes; stops at the first flush when asked.
fnfunction	pktLine()	Encode one UTF-8 text packet with its byte-counted four-byte Git header.
fnfunction	acceptedRefs()	Refs the provider accepted, read from report-status (with or without side-band).
fnfunction	parseReceivePack()	Fail closed on any command the maintained Git wire contract does not support.
fnfunction	refusalReport()	Whole-push refusal in report-status, including the negotiated side-band framing.
fnfunction	sideBandData()	Data channel of an upload-pack side-band reply; fatal server messages refuse.
fnfunction	advertisedRefs()	Ref names and object IDs from the maintained smart-HTTP advertisement framing.
fnfunction	advertisedCapabilities()	Capabilities from the ref advertisement’s first NUL-delimited capability list.

ReceivePackTtype alias

Signature

type ReceivePack =
  | Readonly<{
      kind: "ok";
      updates: readonly GitRefUpdate[];
      capabilities: readonly string[];
    }>
  | Readonly<{
      kind: "probe";
    }>
  | Readonly<{
      kind: "invalid";
      reason: "unparsable" | "push-cert" | "too-many";
    }>;

The decoded receive-pack command section; pack bytes remain unopened.

readPacketLines()fnfunction

Signature

function readPacketLines(
  bytes,
  stopAtFlush,
  strict?,
): Uint8Array<ArrayBufferLike>[];

Split pkt-lines from the start of bytes; stops at the first flush when asked.

Parameters

Parameter	Type	Default value
bytes	Uint8Array	undefined
stopAtFlush	boolean	undefined
strict	boolean	false

Returns

Uint8Array<ArrayBufferLike>[]

---

pktLine()fnfunction

Signature

function pktLine(text): string;

Encode one UTF-8 text packet with its byte-counted four-byte Git header.

Parameters

Parameter	Type
text	string

Returns

string

---

acceptedRefs()fnfunction

Signature

function acceptedRefs(response, sideBand): ReadonlySet<string>;

Refs the provider accepted, read from report-status (with or without side-band).

Parameters

Parameter	Type
response	Uint8Array
sideBand	boolean

Returns

ReadonlySet<string>

---

parseReceivePack()fnfunction

Signature

function parseReceivePack(body): ReceivePack;

Fail closed on any command the maintained Git wire contract does not support.

Parameters

Parameter	Type
body	Uint8Array

Returns

ReceivePack

---

refusalReport()fnfunction

Signature

function refusalReport(verdict, updates, capabilities): Uint8Array;

Whole-push refusal in report-status, including the negotiated side-band framing.

Parameters

Parameter	Type
verdict	| { allowed: true; } | { allowed: false; refused: object[]; } & object
updates	readonly object[]
capabilities	readonly string[]

Returns

Uint8Array

---

sideBandData()fnfunction

Signature

function sideBandData(body): Uint8Array;

Data channel of an upload-pack side-band reply; fatal server messages refuse.

Parameters

Parameter	Type
body	Uint8Array

Returns

Uint8Array

---

advertisedRefs()fnfunction

Signature

function advertisedRefs(body): ReadonlyMap<string, string>;

Ref names and object IDs from the maintained smart-HTTP advertisement framing.

Parameters

Parameter	Type
body	Uint8Array

Returns

ReadonlyMap<string, string>

---

advertisedCapabilities()fnfunction

Signature

function advertisedCapabilities(body): ReadonlySet<string>;

Capabilities from the ref advertisement’s first NUL-delimited capability list.

Parameters

Parameter	Type
body	Uint8Array

Returns

ReadonlySet<string>