Skip to content

fluidtrends/lali

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lali

Local Amorphous Link Installer

Lali helps you install amorphous links locally. Lali understands an amorphous link as being a remote Tar GZip archive.


Latest Release Build

Module Coverage Style

Basic Usage

// Import Lali with default options
const lali = require('lali')

// Install an amorphous link locally
lali.link(<a .tar.gz link>)
     .install(<local path>)
     .then(() => {
       // Link data is now available locally
     })
     .catch((error) => {
       // Something went wrong and the link was not installed
     })

Core API

link(url)

Creates a reference to an amorphous link.

Example:

const link = lali.link('http://some/url/goes/here.tar.gz')

Link API

install(dest)

Returns a promise

Install the link at a local destination.

Example:

lali.link('http://some/url/goes/here.tar.gz').install('/some/local/path')
.then(() => {
  // Link data is now available locally
})
.catch((error) => {
  // Something went wrong and the link was not installed
})

Dependencies

Lali makes use of the following libraries:

  • got - for remote calls