Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
grunt-box-view
Advanced tools
Readme
Box View API grunt tasks
This plugin requires Grunt ~0.4.5
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-box-view --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-box-view');
Upload a document to the View API
In your project's Gruntfile, add a section named boxview-upload
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
'boxview-upload': {
somefile: {
options: {
file: '/path/to/some/file.pdf'
uploadOptions: {
'non_svg': true
}
}
}
},
});
Type: String
Default value: null
A string value of a local file to upload.
Type: String
Default value: null
A string value of a URL to a file to upload.
Type: Object
Default value: {}
An object representing the upload parameters to use (see node-box-view docs for more details).
Create a session for a document on the View API
In your project's Gruntfile, add a section named boxview-session
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
'boxview-session': {
somefile: {
options: {
documentId: 'somedocumentuuid'
sessionOptions: {
duration: 99999999
}
}
}
},
});
Type: String
Default value: null
A string value of the document id to use when creating the session.
Type: Object
Default value: {}
An object representing the session parameters to use (see node-box-view docs for more details).
Upload and create a session for a document on the View API
In your project's Gruntfile, add a section named boxview-view
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
'boxview-view': {
somefile: {
options: {
url: 'http://some.url/file.pdf',
uploadOptions: {
name: 'awesome pdf'
},
sessionOptions: {
duration: 99999999
}
}
}
},
});
Type: String
Default value: null
A string value of a local file to upload.
Type: String
Default value: null
A string value of a URL to a file to upload.
Type: Object
Default value: {}
An object representing the upload parameters to use (see node-box-view docs for more details).
Type: Object
Default value: {}
An object representing the session parameters to use (see node-box-view docs for more details).
List documents uploaded to the View API
In your project's Gruntfile, add a section named boxview-list
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
'boxview-list': {
mytask: {
options: {
limit: 5,
callback: function (res) {
console.log(JSON.stringify(res, true, 2));
}
}
}
},
});
An object representing the list parameters to use (see node-box-view docs for more details).
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
FAQs
Box View API grunt tasks
The npm package grunt-box-view receives a total of 1 weekly downloads. As such, grunt-box-view popularity was classified as not popular.
We found that grunt-box-view demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.