Git Product home page Git Product logo

rclone-js-api's Introduction

JavaScript api for rclone rc

This is a javascript api to access the rclone rc api.

How to install

If you are using npm,

npm install rclone-api --save

or using yarn,

yarn install rclone-api 

Usage

Import the required function

import {getAllProviders} from "rclone-api";

And then,

getAllProviders().then(res => {
    //... do something with the data
}, error => {
    //... do something with the error
    //eg: alert(error)
});

OR

getAllProviders().then(res => {
    //... do something with the data
}).catch( error => {
    //... do something with the error
    //eg: alert(error)
});

Supported calls

  1. getStats(): returns the current rclone stats.
  2. getCurrentBandwidthSetting(): fetches the current limit that is max which the rclone can send request at.
  3. setCurrentBandwidthSetting(newRate): changes the current bandwidth limit of the rclone backend. @param newRate {string} Human readable format of size eg: 1M|2M|1.2G specifying 1MB, 2MB, 1.2GB respectively.
  4. createPublicLink(remoteName, remotePath) creates a public link for a supported remote
  5. getAllProviders() returns all the possible providers supported by the rclone backend
  6. getAllConfigDump() return the configured remotes from the rclone backend
  7. getFsInfo(remoteName) fetches the information regarding features, hashes from the rclone backend.
  8. getFilesList(remoteName, remotePath) fetches the files for a specified remote path (remoteName + remotePath).
  9. getRemoteInfo(remoteName) fetches the information about a provider.
  10. getRcloneVersion() fetches the version and details about the running rclone version.
  11. getAllRemoteNames() fetches all the remotes in the config.

rclone-js-api's People

Contributors

hexpandaa avatar negative0 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.