Skip to content
Burrow0.1.0
API reference

burrow

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/burrow";

Exports

Section titled “Exports”
Kind Export Description
class ArtifactsRestError A failed Artifacts REST call, with the binding’s error code.
type alias ArtifactsRepository Stable repository identity exposed to callers; no credentials or remote URL.
type alias GitExchange One admitted Git smart-HTTP advertisement or byte-stream exchange.
type alias Artifacts Configured repository owner; authorization belongs to its calling host.
type alias ArtifactsRestOptions Where the REST API is and how to reach it.
function createArtifactsRestNamespace() An Artifacts namespace reached over REST, with the binding’s shape.

ArtifactsRestErrorclass

Section titled “ArtifactsRestError”

A failed Artifacts REST call, with the binding’s error code.

Extends

Section titled “Extends”
  • Error

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
Signature
new ArtifactsRestError(code, message): ArtifactsRestError;
Parameters
Section titled “Parameters”
Parameter Type
code string
message string
Returns
Section titled “Returns”

ArtifactsRestError

Overrides
Section titled “Overrides”
Signature
Error.constructor;

Properties

Section titled “Properties”

code

Section titled “code”
Signature
readonly code: string;

ArtifactsRepositorytype alias

Section titled “ArtifactsRepository”
Signature
type ArtifactsRepository = Readonly<{
  id: string;
  name: string;
  defaultBranch: string;
}>;

Stable repository identity exposed to callers; no credentials or remote URL.

GitExchangetype alias

Section titled “GitExchange”
Signature
type GitExchange = Readonly<{
  protocol?: string;
  signal?: AbortSignal;
}> &
  | Readonly<{
  repository: string;
  operation: "upload-pack-advertisement" | "receive-pack-advertisement";
}>
  | Readonly<{
  repository: string;
  operation: "upload-pack" | "receive-pack";
  body: ReadableStream<Uint8Array>;
}>;

One admitted Git smart-HTTP advertisement or byte-stream exchange.

Artifactstype alias

Section titled “Artifacts”
Signature
type Artifacts = Readonly<{
  ensureRepository: Promise<
    Readonly<{
      id: string;
      name: string;
      defaultBranch: string;
    }>
  >;
  forkRepository: Promise<
    Readonly<{
      repository: ArtifactsRepository;
      mainHead: string;
      disposition: "created" | "existing";
    }>
  >;
  recoverForkRepository: Promise<Readonly<{
    repository: ArtifactsRepository;
    mainHead: string;
    disposition: "created" | "existing";
  }> | null>;
  resolveRepository: Promise<
    Readonly<{
      id: string;
      name: string;
      defaultBranch: string;
    }>
  >;
  readDefaultBranchHead: Promise<string | null>;
  readBranchHeads: Promise<readonly string[]>;
  readRefs: Promise<
    readonly Readonly<{
      name: string;
      hash: string;
    }>[]
  >;
  exchangeGit: Promise<Response>;
}>;

Configured repository owner; authorization belongs to its calling host.

ArtifactsRestOptionstype alias

Section titled “ArtifactsRestOptions”
Signature
type ArtifactsRestOptions = Readonly<{
  accountId: string;
  namespace: string;
  apiToken: string;
  fetch?: typeof fetch;
}>;

Where the REST API is and how to reach it.

createArtifactsRestNamespace()function

Section titled “createArtifactsRestNamespace()”
Signature
function createArtifactsRestNamespace(options): ArtifactsNamespace;

An Artifacts namespace reached over REST, with the binding’s shape.

Parameters

Section titled “Parameters”
Parameter Type
options ArtifactsRestOptions

Returns

Section titled “Returns”

ArtifactsNamespace

References

Section titled “References”

createCloudflareArtifacts

Section titled “createCloudflareArtifacts”

Re-exports createCloudflareArtifacts

CloudflareArtifactsNamespace

Section titled “CloudflareArtifactsNamespace”

Re-exports CloudflareArtifactsNamespace

CloudflareArtifactsOptions

Section titled “CloudflareArtifactsOptions”

Re-exports CloudflareArtifactsOptions

ArtifactsNamespace

Section titled “ArtifactsNamespace”

Re-exports ArtifactsNamespace

ArtifactsCommit

Section titled “ArtifactsCommit”

Re-exports ArtifactsCommit

ArtifactsRepositoryInfo

Section titled “ArtifactsRepositoryInfo”

Re-exports ArtifactsRepositoryInfo