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
GitResolver
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 GitResolver
Hierarchy
GitResolver
Implements
Resolver
Methods
bindDescriptor
getCandidates
getResolutionDependencies
getSatisfying
resolve
shouldPersistResolution
supportsDescriptor
supportsLocator
Methods
bind
Descriptor
bind
Descriptor
(
descriptor
:
Descriptor
, fromLocator
:
Locator
, opts
:
MinimalResolveOptions
)
:
Descriptor
Parameters
descriptor:
Descriptor
fromLocator:
Locator
opts:
MinimalResolveOptions
Returns
Descriptor
get
Candidates
get
Candidates
(
descriptor
:
Descriptor
, dependencies
:
unknown
, opts
:
ResolveOptions
)
:
Promise
<
Locator
[]
>
Parameters
descriptor:
Descriptor
dependencies:
unknown
opts:
ResolveOptions
Returns
Promise
<
Locator
[]
>
get
Resolution
Dependencies
get
Resolution
Dependencies
(
descriptor
:
Descriptor
, opts
:
MinimalResolveOptions
)
:
object
Parameters
descriptor:
Descriptor
opts:
MinimalResolveOptions
Returns
object
get
Satisfying
get
Satisfying
(
descriptor
:
Descriptor
, dependencies
:
Record
<
string
,
Package
>
, locators
:
Array
<
Locator
>
, opts
:
ResolveOptions
)
:
Promise
<
object
>
Parameters
descriptor:
Descriptor
dependencies:
Record
<
string
,
Package
>
locators:
Array
<
Locator
>
opts:
ResolveOptions
Returns
Promise
<
object
>
resolve
resolve
(
locator
:
Locator
, opts
:
ResolveOptions
)
:
Promise
<
object
>
Parameters
locator:
Locator
opts:
ResolveOptions
Returns
Promise
<
object
>
should
Persist
Resolution
should
Persist
Resolution
(
locator
:
Locator
, opts
:
MinimalResolveOptions
)
:
boolean
Parameters
locator:
Locator
opts:
MinimalResolveOptions
Returns
boolean
supports
Descriptor
supports
Descriptor
(
descriptor
:
Descriptor
, opts
:
MinimalResolveOptions
)
:
boolean
Parameters
descriptor:
Descriptor
opts:
MinimalResolveOptions
Returns
boolean
supports
Locator
supports
Locator
(
locator
:
Locator
, opts
:
MinimalResolveOptions
)
:
boolean
Parameters
locator:
Locator
opts:
MinimalResolveOptions
Returns
boolean
plugin-
git
"@yarnpkg/core"
Treeish
Protocols
Git
Fetcher
Git
Resolver
bind
Descriptor
get
Candidates
get
Resolution
Dependencies
get
Satisfying
resolve
should
Persist
Resolution
supports
Descriptor
supports
Locator
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
validate
Repo
Url
plugin
Generated using
TypeDoc