Light

filepreviews / filepreviews.js Goto Github PK

View Code? Open in Web Editor NEW

54.0 4.0 8.0 110 KB

Deprecated: JavaScript client library for the FilePreviews.io service

Home Page: http://filepreviews.io

License: MIT License

JavaScript 89.87% HTML 9.55% Shell 0.58%

filepreviews javascript

filepreviews.js's Introduction

⚠️ Deprecated ⚠️

FilePreviews.io

JavaScript client library for the FilePreviews.io service.

How to use

Install using bower

bower install filepreviews

Use from our CDN distribution

<script src="https://dufozrddxzwdn.cloudfront.net/2.0.3/filepreviews.min.js"></script>
<script src="https://dufozrddxzwdn.cloudfront.net/2.0.3/filepreviews.js"></script>

Download

You can also download the latest version from the releases page.

Example code

var previews = new FilePreviews({
  debug: true,
  apiKey: 'API_KEY_HERE'
});

previews.generate(url, function(err, result) {
  console.log(result.id);
  console.log(result.status);

  previews.retrieve(result.id, function(err, result) {
    console.log(result);
  });
});

Options

You can optinally send an options object.

var previews = new FilePreviews({
  debug: true,
  apiKey: 'CLIENT_API_KEY_HERE'
});

var options = {
  size: {
    width: 250,
    height: 250,
  },
  metadata: ['exif', 'ocr', 'psd'],
  format: 'jpg'
}

previews.generate(url, options, function(err, result) {
  console.log(result.previewURL);
  console.log(result.metadata);
});

Build

$ git clone https://github.com/GetBlimp/filepreviews.js.git
$ cd filepreviews.js
$ npm run build

Publish

$ npm run publish

filepreviews.js's People

Contributors

Stargazers

Watchers

Forkers

elving hengkiardo tornad todrobbins jpadilla sayi21cn kaoschuks voonshunzhi

filepreviews.js's Issues

Preview URL is not encoded

If the file url has spaces in it, the preview url generated by the API returns a non encoded url. The problem with this is that if the url has spaces, the link fails since it is not encoded.

For example, notice the first url that it is not encoded and does not work. The second url works since it doesn't have spaces.

A simple fix, could be this:

encodeURI(<previewURL>);

It's not a mayor issue, since this can be fixed on the client side of using the library.

Note: that their maybe other characters that may need encoding as well.

Demo is not working

http://jsbin.com/losaf/39/edit?js,output

Uncaught TypeError: FilePreviews.getPreviewURL is not a function

XMLHttpRequest.withCredentials should initially be false

This is somewhat obscure, but I'm working on a site that includes both your library and reactS3Uploader. Their code causes an error if withCredentials is set to undefined on an XMLHttpRequest. The spec also requires its value to initially be false.

It looks like you custom XMLHttpRequest code appears to result in withCredentials initially being undefined.

The result was that including filepreviews broke by other s3uploader.

JS Bin Demo Not Working

Not sure the full cause of it, but the demo on JS Bin seems to currently be dead.

Error: ENOENT: no such file or directory, lstat 'bower_components'

After following the instructions in the Github README, I was able to install filepreviews into my project. However when I try to run it, I get this error Error: ENOENT: no such file or directory, lstat 'bower_components'

I have npm install-ed and have everything up to date and during the install I saw bower_components being referenced but is not longer in the project. Has anyone else run into this?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.