JSPM

  • Created
  • Published
  • Downloads 147
  • Score
    100M100P100Q55107F
  • License BSD-2-Clause-FreeBSD

Provide utilities for common tasks such as, file compression, file download, OS integration, exec, etc

Package Exports

  • @vimlet/commons

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vimlet/commons) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

build test

Vimlet Commons Modules:

Provides a cross environment standardized API for common used functions.

This module is a constant effort of improvement to achieve a stable and flexible, free open-source solution, for common case developing needs.

Currently supporting:

  • OS
  • Run
  • Request
  • Compress
  • Util
  • Progress

You can access the source code at https://github.com/vimlet/VimletCommons

Basic usage:


const commons = require("@vimlet/commons");

var src = require("path").join(__dirname, "resources/compress/pack");
var dst = require("path").join(__dirname, "resources/compress/file.zip");

commons.compress.pack(src, dst, "zip", null, null, function(error) {
    if(error) {
        console.log("Fail");
    } else {
        console.log("Success");
    }
});

Documentation

Documentation is an ongoing effort, hopefully it will get better and better over time.

To view the documentation page click here!


License

This project is licensed under FreeBSD 2 clause license


Issues

Please report issues at github issues:

Known issues

  • Run module should provide a more flexible encoding capabilities.