Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

monaca-lib

Package Overview
Dependencies
23
Maintainers
5
Versions
119
Issues
File Explorer

Advanced tools

monaca-lib

Monaca cloud and localkit API bindings for JavaScript

    4.1.0latest

Version published
Maintainers
5
Yearly downloads
7,434
decreased by-34.97%

Weekly downloads

Readme

Source

Monaca Cloud API

This is a library used to communicate with the Monaca Cloud REST API.

Initialization

From version 2.5.0, clientType: 'lib' needs to be specified when monaca-lib is initialized for standalone use.

Example:

var Monaca = require('monaca-lib').Monaca; var monaca = new Monaca({clientType: 'lib'});

Example usage

var Monaca = require('monaca-lib').Monaca; var monaca = new Monaca({clientType: 'lib'}); monaca.login('[email protected]', 'password').then( function() { console.log('Succesfully logged in!'); monaca.cloneProject('PROJECT_ID', '/destination/directory').then( function() { console.log('Successfully clone project!'); }, function(error) { console.log('Clone failed: ' + error); }, function(progress) { console.log('Downloading ' + progress.path); } ); }, function(error) { console.log('Login failed: ' + error); } );

There is also a Localkit class that is used to connect a local development environment to the Monaca Debugger.

var monacaLib = require('monaca-lib'), Monaca = monacaLib.Monaca, Localkit = monacaLib.Localkit; var monaca = new Monaca({clientType: 'lib'}); var localkit = new Localkit(monaca, '/path/to/project'); localkit.startHttpServer().then( function() { localkit.startBeaconTransmitter().then( function() { console.log('Localkit will now wait for connections from the Monaca debugger.'); } ); } );

Running tests

To run the tests use the following command:

$ export MONACA_TEST_EMAIL[email protected] $ export MONACA_TEST_PASSWORD=password $ npm test

Building the documentation

The documentation is built using JSDoc. Use the following command in the root directory to build the documentation:

$ jsdoc src

The generated documentation can be found in out/index.html.

Keywords

FAQs

What is monaca-lib?

Monaca cloud and localkit API bindings for JavaScript

Is monaca-lib popular?

The npm package monaca-lib receives a total of 91 weekly downloads. As such, monaca-lib popularity was classified as not popular.

Is monaca-lib well maintained?

We found that monaca-lib demonstrated a healthy version release cadence and project activity. It has 5 open source maintainers collaborating on the project.

Last updated on 15 Feb 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc