core/fetcher

Interfaces

FetchResult

Defined in: venpm/src/core/fetcher.ts:11

Properties

git_ref?

optional git_ref?: string;

Defined in: venpm/src/core/fetcher.ts:14

Git commit hash (only set when method === "git")

method

method: FetchMethod;

Defined in: venpm/src/core/fetcher.ts:12

path?

optional path?: string;

Defined in: venpm/src/core/fetcher.ts:16

Subdirectory path within the plugin dir (carried through from source)

Functions

fetchPlugin()

function fetchPlugin(
   entry, 
   userpluginDir, 
ctx): Promise<FetchResult>;

Defined in: venpm/src/core/fetcher.ts:128

Parameters

Parameter	Type
entry	InstallPlanEntry
userpluginDir	string
ctx	{ fs: FileSystem; git: GitClient; http: HttpClient; }
ctx.fs	FileSystem
ctx.git	GitClient
ctx.http	HttpClient

Returns

Promise<FetchResult>

---

fetchViaGit()

function fetchViaGit(
   git, 
   fs, 
   gitUrl, 
   dest, 
options?): Promise<FetchResult>;

Defined in: venpm/src/core/fetcher.ts:21

Parameters

Parameter	Type
git	GitClient
fs	FileSystem
gitUrl	string
dest	string
options	{ path?: string; tag?: string; }
options.path?	string
options.tag?	string

Returns

Promise<FetchResult>

---

fetchViaLocal()

function fetchViaLocal(
   fs, 
   localPath, 
dest): Promise<FetchResult>;

Defined in: venpm/src/core/fetcher.ts:97

Parameters

Parameter	Type
fs	FileSystem
localPath	string
dest	string

Returns

Promise<FetchResult>

---

fetchViaTarball()

function fetchViaTarball(
   http, 
   fs, 
   tarballUrl, 
dest): Promise<FetchResult>;

Defined in: venpm/src/core/fetcher.ts:67

Parameters

Parameter	Type
http	HttpClient
fs	FileSystem
tarballUrl	string
dest	string

Returns

Promise<FetchResult>