js-google-drive
v1.0.0
Published
This wrapper provides you simplified functionality to handle the Google Drive API.
Downloads
1
Readme
JavaScript Google Drive Wrapper
This wrapper provides you simplified functionality to handle the Google Drive API.
Installation
npm install --save js-google-drive
Prerequisite
You need a Google OAuth2 token. You can obtain it with the JavaScript Google OAuth2 Wrapper.
Usage
// Load module
const Drive = require('js-google-drive');
// Create new instance (with token)
const drive = new Drive('token...');
// Use methods
drive.createFolder('Main Folder/Sub Folder', (error, id) => {
if (error) console.log('Error', error.message);
else console.log(`Folder created with ID ${id}`);
})
Note: You need to build this script with Webpack or similar first. See the example at the page end.
Methods
createFolder(options, [callback])
Creates folder or folder structure.
options
object (if path is the only parameter, it could be passed as string)path
stringdescription
string, optionalfolderColorRgb
hex string, optional, example: #808080starred
boolean, optionalparentId
string, optional, defaultroot
callback
function(error, id), optional
If the asynchronious request failes, callback is called with an error as first argument. If the request is successfull, callback is called with null as first and and the folder id as second argument.
list([options, callback])
List files by options.
options
object, optional, accepts the following parameters- all parameters described at the Google API documentation
fields
string, define comma-separated fields to return, by defaultid,name
(all fields)
callback
function(error, files), optional
If the asynchronious request failes, callback is called with an error as first argument. If the request is successfull, callback is called with null as first and an array of files as second argument.
Example
This example will handle the sign-in / sign-out process and display five files of your Google Drive.
- Run
https://github.com/scriptPilot/js-google-drive.git
to clone this repo - Run
cd js-google-drive/example
to open the example folder - Update values in
config.example.json
and save asconfig.json
- Run
npm install
to install all dependencies - Run
npm start
to open the Webpack dev server at localhost:8080