@fungi.computer/agar 0.0.0-stage → 0.0.1

package/docs/api/git-wire.md

@@ -0,0 +1,197 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/agar**](README.md)
+
+---
+
+[@fungi.computer/agar](modules.md) / git-wire
+
+# git-wire
+
+## Type Aliases
+
+### ReceivePack
+
+```ts
+type ReceivePack =
+  | Readonly<{
+      kind: "ok";
+      updates: readonly GitRefUpdate[];
+      capabilities: readonly string[];
+    }>
+  | Readonly<{
+      kind: "invalid";
+      reason: "unparsable" | "push-cert" | "too-many";
+    }>;
+```
+
+The decoded receive-pack command section; pack bytes remain unopened.
+
+## Functions
+
+### readPacketLines()
+
+```ts
+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()
+
+```ts
+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()
+
+```ts
+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()
+
+```ts
+function parseReceivePack(body): ReceivePack;
+```
+
+Fail closed on any command the maintained Git wire contract does not support.
+
+#### Parameters
+
+| Parameter | Type         |
+| --------- | ------------ |
+| `body`    | `Uint8Array` |
+
+#### Returns
+
+[`ReceivePack`](#receivepack)
+
+---
+
+### refusalReport()
+
+```ts
+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()
+
+```ts
+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()
+
+```ts
+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()
+
+```ts
+function advertisedCapabilities(body): ReadonlySet<string>;
+```
+
+Capabilities from the ref advertisement's first NUL-delimited capability list.
+
+#### Parameters
+
+| Parameter | Type         |
+| --------- | ------------ |
+| `body`    | `Uint8Array` |
+
+#### Returns
+
+`ReadonlySet`\<`string`\>