Skip to content
packagesgitreference

@vltpkg/git

Type Aliases

FindOpts

type FindOpts = object

Defined in: find.ts:4

Type declaration

cwd?
optional cwd: string;
root?
optional root: string;

GitOptions

type GitOptions = PickManifestOptions & SpawnOptions & object

Defined in: index.ts:18

This extends all options that can be passed to spawn() or pickManifest.

Type declaration

cwd?
optional cwd: string;

the current working directory to perform git operations in

fetch-retries?
optional fetch-retries: WrapOptions["retries"];

Only relevant if retry is unset. Value for retry.retries, default 2

fetch-retry-factor?
optional fetch-retry-factor: WrapOptions["factor"];

Only relevant if retry is unset. Value for retry.factor, default 10

fetch-retry-maxtimeout?
optional fetch-retry-maxtimeout: WrapOptions["maxTimeout"];

Only relevant if retry is unset. Value for retry.maxTimeout, default 60_000

fetch-retry-mintimeout?
optional fetch-retry-mintimeout: WrapOptions["minTimeout"];

Only relevant if retry is unset. Value for retry.minTimeout, default 1_000

git?
optional git: string | false;

the path to git binary, or ‘false’ to prevent all git operations

git-shallow?
optional git-shallow: boolean;

Set to a boolean to force cloning with/without --depth=1. If left undefined, then shallow cloning will only be performed on hosts known to support it.

noGitRevCache?
optional noGitRevCache: boolean;

Just to test rev lookup without continually clearing the cache

spec?
optional spec: Spec;

Parsed git specifier to be cloned, if we have one

GitUser

type GitUser = object

Defined in: user.ts:3

Type declaration

email?
optional email: string;
name?
optional name: string;

Variables

shallowHosts

const shallowHosts: Set<string>

Defined in: clone.ts:27

Only these whitelisted hosts get shallow cloning. Many hosts (including GHE) don’t always support it. A failed shallow fetch takes a LOT longer than a full fetch in most cases, so we skip it entirely. Set opts.gitShallow = true/false to force this behavior one way or the other.

If other hosts are added to this set, then they will be shallowly cloned as well.

Functions

clone()

function clone(repo, ref, target, opts): Promise<string>

Defined in: clone.ts:35

Parameters

repo

string

ref

string = 'HEAD'

target

undefined | string

opts

GitOptions = {}

Returns

Promise<string>

find()

function find(__namedParameters): Promise<undefined | string>

Defined in: find.ts:8

Parameters

__namedParameters

FindOpts = {}

Returns

Promise<undefined | string>

getUser()

function getUser(opts): Promise<undefined | GitUser>

Defined in: user.ts:8

Parameters

opts

Returns

Promise<undefined | GitUser>

is()

function is(__namedParameters): Promise<boolean>

Defined in: is.ts:3

Parameters

__namedParameters
cwd

string = ...

Returns

Promise<boolean>

isClean()

function isClean(opts): Promise<boolean>

Defined in: is-clean.ts:4

Parameters

opts

Returns

Promise<boolean>

resolve()

function resolve(repo, ref, opts): Promise<undefined | RevDocEntry>

Defined in: resolve.ts:13

Given a repo and either a ref or a git specifier Spec object, resolve the appropriate ref that we should clone, ideally witout actually cloning the repository.

Parameters

repo

string

ref

string = 'HEAD'

opts

GitOptions = {}

Returns

Promise<undefined | RevDocEntry>

resolveRef()

function resolveRef(revDoc, ref, opts): undefined | RevDocEntry

Defined in: resolve.ts:29

Given a repo’s RevDoc object and either a ref or a git specifier Spec object, resolve the appropriate ref that we should clone, witout actually cloning the repository.

Parameters

revDoc

RevDoc

ref

string = 'HEAD'

opts

GitOptions = {}

Returns

undefined | RevDocEntry

revs()

function revs(repo, opts): Promise<undefined | RevDoc>

Defined in: revs.ts:32

Parameters

repo

string

opts

GitOptions = {}

Returns

Promise<undefined | RevDoc>

spawn()

function spawn(
  gitArgs,
  opts,
): Promise<SpawnResultStderrString & SpawnResultStdoutString>

Defined in: spawn.ts:13

Parameters

gitArgs

string[]

opts

GitOptions = {}

Returns

Promise<SpawnResultStderrString & SpawnResultStdoutString>