Package com.artipie.npm.proxy

Interface NpmRemote

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CircuitBreakerNpmRemote, HttpNpmRemote

public interface NpmRemote
extends Closeable

NPM Remote client interface.

Since:

0.1

Method Summary

Modifier and Type	Method	Description
io.reactivex.Maybe<NpmAsset>	loadAsset(String path, Path tmp)	Loads asset from remote repository.
io.reactivex.Maybe<NpmPackage>	loadPackage(String name)	Loads package from remote repository.

Methods inherited from interface java.io.Closeable

close

Method Detail

loadPackage

io.reactivex.Maybe<NpmPackage> loadPackage(String name)

Loads package from remote repository.

Parameters:

name - Package name

Returns:

NPM package or empty

loadAsset

io.reactivex.Maybe<NpmAsset> loadAsset(String path,
                                       Path tmp)

Loads asset from remote repository. Typical usage for client:

 Path tmp = <create temporary file>
 NpmAsset asset = remote.loadAsset(asset, tmp);
 ... consumes asset's data ...
 Files.delete(tmp);
 

Parameters:

path - Asset path

tmp - Temporary file to store asset data

Returns:

NpmAsset or empty