js-google-drive

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 string
  • description string, optional
  • folderColorRgb hex string, optional, example: #808080
  • starred boolean, optional
  • parentId string, optional, default root
• 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 default id,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.

1. Run https://github.com/scriptPilot/js-google-drive.git to clone this repo
2. Run cd js-google-drive/example to open the example folder
3. Update values in config.example.json and save as config.json
4. Run npm install to install all dependencies
5. Run npm start to open the Webpack dev server at localhost:8080