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-github
GithubFetcher
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 GithubFetcher
Hierarchy
GithubFetcher
Implements
Fetcher
Methods
fetch
fetchFromNetwork
getLocalPath
getLocatorUrl
supports
Methods
fetch
fetch
(
locator
:
Locator
, opts
:
FetchOptions
)
:
Promise
<
object
>
Parameters
locator:
Locator
opts:
FetchOptions
Returns
Promise
<
object
>
fetch
From
Network
fetch
From
Network
(
locator
:
Locator
, opts
:
FetchOptions
)
:
Promise
<
ZipFS
>
Parameters
locator:
Locator
opts:
FetchOptions
Returns
Promise
<
ZipFS
>
get
Local
Path
get
Local
Path
(
locator
:
Locator
, opts
:
FetchOptions
)
:
null
Parameters
locator:
Locator
opts:
FetchOptions
Returns
null
Private
get
Locator
Url
get
Locator
Url
(
locator
:
Locator
, opts
:
MinimalFetchOptions
)
:
string
Parameters
locator:
Locator
opts:
MinimalFetchOptions
Returns
string
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
plugin-
github
Github
Fetcher
fetch
fetch
From
Network
get
Local
Path
get
Locator
Url
supports
Parsed
Github
Url
github
Patterns
invalid
Scenarios
valid
Scenarios
invalid
Github
Url
Message
is
Github
Url
parse
Github
Url
plugin
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