Skip to content
Node.js Client for IDRsolutions BuildVu Microservice Example
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
.gitattributes
.gitignore
CODE_OF_CONDUCT.md
LICENSE.txt
README.md
buildvu-client.js
example.js
package-lock.json
package.json

README.md

BuildVu Node.js Client

Convert PDF to HTML5 or SVG with Node.js, using the BuildVu Node.js Client to interact with IDRsolutions' BuildVu Microservice Example.

The BuildVu Microservice Example is an open source project that allows you to convert PDF to HTML5 or SVG by running BuildVu as an online service.

IDRsolutions offer a free trial service for running BuildVu with Node.js, more infomation on this can be found here.


Installation

npm install @idrsolutions/buildvu

Usage

Basic: (Upload)

var buildvu = require('@idrsolutions/buildvu');

var endpoint = "http://localhost:8080/buildvu-microservice/";

buildvu.convert({
    endpoint: endpoint,
    parameters: {
        // Upload a local file to the server
        input: buildvu.UPLOAD,
        file: "path/to/file.pdf",
        token: "token-if-required"
    },
    
    failure: function(e) {
        console.log(e);
    },
    progress: function() { },
    success: function(e) {
        console.log('Converted ' + e.downloadUrl);
    }

});

Basic: (Download)

var buildvu = require('@idrsolutions/buildvu');

var endpoint = "http://localhost:8080/buildvu-microservice/";

buildvu.convert({
    endpoint: endpoint,
    parameters: {
        // Download a remote file on the server
        input: buildvu.DOWNLOAD,
        url: 'http://example/url/file.pdf'
    },

    failure: function(e) {
        console.log(e);
    },
    progress: function() { },
    success: function(e) {
        console.log('Converted ' + e.downloadUrl);
    }
    
});

The parameters object should contain the parameters that are sent to the API See the API for more details.

See example.js for examples.


Who do I talk to?

Found a bug, or have a suggestion / improvement? Let us know through the Issues page.

Got questions? You can contact us here.


Code of Conduct

Short version: Don't be an awful person.

Longer version: Everyone interacting in the BuildVu Node.js Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.


Copyright 2018 IDRsolutions

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.