Socket
Socket
Sign inDemoInstall

node-box-api

Package Overview
Dependencies
22
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    node-box-api

Box API for Nodejs


Version published
Maintainers
1
Install size
1.22 MB
Created

Readme

Source

node-box-api

Currently supporting basic Box Content API

Working towards full feature support of Box Content API & Box View API

https://box-content.readme.io/reference

https://box-view.readme.io/reference

Install

npm install node-box-api

Setup

var Box = require('node-box-api');

var box = new Box({
	client_id: 'APPLICATION_CLIENT_ID',
	client_secret: 'APPLICATION_CLIENT_SECRET',
	access_token: 'USER_ACCESS_TOKEN',
	refresh_token: 'USER_REFRESH_TOKEN'
});

Examples

Folders API

After instantiating the Box class you can call API resources by calling box.folders

Get Root Folder's Info
box.folders.root(function(err, res) {
	console.log(res);
});
Get Folder's Info
box.folders.info('FOLDER_ID', function(err, res) {
	console.log(res);
});
Get Folder's Items
var params = {
	limit: 100,
	offset: 0,
	fields: 'name,etc'
};
box.folders.items('FOLDER_ID', params, function(err, res) {
	console.log(res);
});

The params argument is optional

box.folders.items('FOLDER_ID', function(err, res) {
	console.log(res);
});

Files API

After instantiating the Box class you can call API resources by calling box.files

Get File's Info
box.files.info('FILE_ID', function(err, res) {
	console.log(res);
});
Download File
box.files.download('FILE_ID', function(err, res) {
	console.log(res);
});

The download function does accept params, however it is not currently supported

Get Thumbnail
var params = {
	min_height: 32,
	min_width: 32,
	max_height: 256,
	max_width: 256,
	extension: 'jpg'
};
box.files.thumbnail('FILE_ID', params, function(err, res) {
	console.log(res);
});

The params argument is optional

box.files.thumbnail('FILE_ID', function(err, res) {
	console.log(res);
});

Keywords

FAQs

Last updated on 07 Oct 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc