https://github.com/rclone/rclone-js-api
rclone rc bindings for javascript
https://github.com/rclone/rclone-js-api
Last synced: 3 months ago
JSON representation
rclone rc bindings for javascript
- Host: GitHub
- URL: https://github.com/rclone/rclone-js-api
- Owner: rclone
- Created: 2020-06-02T11:07:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T00:10:01.000Z (about 3 years ago)
- Last Synced: 2025-11-09T14:41:13.349Z (6 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 41
- Watchers: 4
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- awesome-rclone - rclone-api - JavaScript client for rclone's RC HTTP API. Promise-based functions for all RC endpoints. **`Inactive, superseded by rclone-sdk`**  (API Libraries and SDKs / JavaScript / TypeScript)
README
# JavaScript api for rclone rc
This is a javascript api to access the [rclone rc](https://rclone.org/rc) api.
# How to install
If you are using npm,
```
npm install rclone-api --save
```
or using yarn,
```shell script
yarn install rclone-api
```
## Usage
Import the required function
```js
import {getAllProviders} from "rclone-api";
```
And then,
```js
getAllProviders().then(res => {
//... do something with the data
}, error => {
//... do something with the error
//eg: alert(error)
});
```
OR
```js
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.
1. ```getCurrentBandwidthSetting()```: fetches the current limit that is max which the rclone can send request at.
1. ```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.
1. ```createPublicLink(remoteName, remotePath)``` creates a public link for a supported remote
1. ```getAllProviders()``` returns all the possible providers supported by the rclone backend
1. ```getAllConfigDump()``` return the configured remotes from the rclone backend
1. ```getFsInfo(remoteName)``` fetches the information regarding features, hashes from the rclone backend.
1. ```getFilesList(remoteName, remotePath)``` fetches the files for a specified remote path (remoteName + remotePath).
1. ```getRemoteInfo(remoteName)``` fetches the information about a provider.
1. ```getRcloneVersion()``` fetches the version and details about the running rclone version.
1. ```getAllRemoteNames()``` fetches all the remotes in the config.
1.