Search
Preparing search index...
The search index is not available
Yarn API
Home
Configuration
Features
CLI
Advanced
GitHub
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
plugin-git
GitFetcher
Globals
{"Generic Packages":{"@yarnpkg/core":"yarnpkg_core","@yarnpkg/fslib":"yarnpkg_fslib","@yarnpkg/libzip":"yarnpkg_libzip","@yarnpkg/nm":"yarnpkg_nm","@yarnpkg/parsers":"yarnpkg_parsers","@yarnpkg/pnp":"yarnpkg_pnp","@yarnpkg/pnpify":"yarnpkg_pnpify","@yarnpkg/sdks":"yarnpkg_sdks","@yarnpkg/shell":"yarnpkg_shell"},"Yarn Packages":{"@yarnpkg/builder":"yarnpkg_builder","@yarnpkg/cli":"yarnpkg_cli"},"Default Plugins":{"@yarnpkg/plugin-compat":"plugin_compat","@yarnpkg/plugin-dlx":"plugin_dlx","@yarnpkg/plugin-essentials":"plugin_essentials","@yarnpkg/plugin-file":"plugin_file","@yarnpkg/plugin-git":"plugin_git","@yarnpkg/plugin-github":"plugin_github","@yarnpkg/plugin-http":"plugin_http","@yarnpkg/plugin-init":"plugin_init","@yarnpkg/plugin-link":"plugin_link","@yarnpkg/plugin-nm":"plugin_nm","@yarnpkg/plugin-npm":"plugin_npm","@yarnpkg/plugin-npm-cli":"plugin_npm_cli","@yarnpkg/plugin-pack":"plugin_pack","@yarnpkg/plugin-patch":"plugin_patch","@yarnpkg/plugin-pnp":"plugin_pnp"},"Contrib Plugins":{"@yarnpkg/plugin-constraints":"plugin_constraints","@yarnpkg/plugin-exec":"plugin_exec","@yarnpkg/plugin-interactive-tools":"plugin_interactive_tools","@yarnpkg/plugin-stage":"plugin_stage","@yarnpkg/plugin-typescript":"plugin_typescript","@yarnpkg/plugin-version":"plugin_version","@yarnpkg/plugin-workspace-tools":"plugin_workspace_tools"}}
Class GitFetcher
Hierarchy
GitFetcher
Implements
Fetcher
Methods
cloneFromRemote
downloadHosted
fetch
getLocalPath
supports
Methods
clone
From
Remote
clone
From
Remote
(
locator
:
Locator
, opts
:
FetchOptions
)
:
Promise
<
ZipFS
>
Parameters
locator:
Locator
opts:
FetchOptions
Returns
Promise
<
ZipFS
>
download
Hosted
download
Hosted
(
locator
:
Locator
, opts
:
FetchOptions
)
:
Promise
<
null
|
object
>
Parameters
locator:
Locator
opts:
FetchOptions
Returns
Promise
<
null
|
object
>
fetch
fetch
(
locator
:
Locator
, opts
:
FetchOptions
)
:
Promise
<
object
>
Parameters
locator:
Locator
opts:
FetchOptions
Returns
Promise
<
object
>
get
Local
Path
get
Local
Path
(
locator
:
Locator
, opts
:
FetchOptions
)
:
null
Parameters
locator:
Locator
opts:
FetchOptions
Returns
null
supports
supports
(
locator
:
Locator
, opts
:
MinimalFetchOptions
)
:
boolean
Parameters
locator:
Locator
opts:
MinimalFetchOptions
Returns
boolean
"scripts/extract-
hooks"
acceptance-
tests
plugin-
compat
plugin-
constraints
plugin-
dlx
plugin-
essentials
plugin-
exec
plugin-
file
plugin-
git
"@yarnpkg/core"
Treeish
Protocols
Git
Fetcher
clone
From
Remote
download
Hosted
fetch
get
Local
Path
supports
Git
Resolver
Hooks
Repo
Url
Parts
INVALID_
PATTERNS
VALID_
PATTERNS
git
Patterns
clone
correctURL
fetch
Base
fetch
Changed
Files
fetch
Changed
Workspaces
fetch
Root
git
is
Git
Url
last
Index
OfBefore
ls
Remote
make
Git
Environment
normalize
Locator
normalize
Repo
Url
resolve
Url
safeURL
split
Repo
Url
try
Parse
GitURL
plugin
plugin-
github
plugin-
http
plugin-
init
plugin-
interactive-
tools
plugin-
link
plugin-
nm
plugin-
npm
plugin-
npm-
cli
plugin-
pack
plugin-
patch
plugin-
pnp
plugin-
pnpm
plugin-
stage
plugin-
typescript
plugin-
version
plugin-
workspace-
tools
vscode-
zipfs
yarnpkg-
builder
yarnpkg-
cli
yarnpkg-
core
yarnpkg-
doctor
yarnpkg-
extensions
yarnpkg-
fslib
yarnpkg-
libui
yarnpkg-
libzip
yarnpkg-
nm
yarnpkg-
parsers
yarnpkg-
pnp
yarnpkg-
pnpify
yarnpkg-
sdks
yarnpkg-
shell
Generated using
TypeDoc