cloudinary/cloudinary_npm


Cloudinary NPM for node.js integration

Language: JavaScript

Keywords: cdn, cloud, image-compression, image-manipulation, image-transformations, image-uploader, nodejs, npm-package, optimize-images, responsive-images, transform-images, video, video-transcoding, video-transformation, video-upload, web-development, web-optimization


Cloudinary

Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline.

Easily upload images to the cloud. Automatically perform smart image resizing, cropping and conversion without installing any complex software. Integrate Facebook or Twitter profile image extraction in a snap, in any dimension and style to match your website’s graphics requirements. Images are seamlessly delivered through a fast CDN, and much much more.

Cloudinary offers comprehensive APIs and administration capabilities and is easy to integrate with any web application, existing or new.

Cloudinary provides URL and HTTP based APIs that can be easily integrated with any Web development framework.

For Node.js, Cloudinary provides an extension for simplifying the integration even further.

Getting started guide

Take a look at our Getting started guide for Node.js.

Setup

npm install cloudinary

Try it right away

Sign up for a free account so you can try out image transformations and seamless image delivery through CDN.

Note: Replace demo in all the following examples with your Cloudinary's cloud name.

Accessing an uploaded image with the sample public ID through a CDN:

http://res.cloudinary.com/demo/image/upload/sample.jpg

Sample

Generating a 150x100 version of the sample image and downloading it through a CDN:

http://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill/sample.jpg

Sample 150x100

Converting to a 150x100 PNG with rounded corners of 20 pixels:

http://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill,r_20/sample.png

Sample 150x150 Rounded PNG

For plenty more transformation options, see our image transformations documentation.

Generating a 120x90 thumbnail based on automatic face detection of the Facebook profile picture of Bill Clinton:

http://res.cloudinary.com/demo/image/facebook/c_thumb,g_face,h_90,w_120/billclinton.jpg

Facebook 90x120

For more details, see our documentation for embedding Facebook and Twitter profile pictures.

Usage

Configuration

Each request for building a URL of a remote cloud resource must have the cloud_name parameter set. Each request to our secure APIs (e.g., image uploads, eager sprite generation) must have the api_key and api_secret parameters set. See API, URLs and access identifiers for more details.

Setting the cloud_name, api_key and api_secret parameters can be done either directly in each call to a Cloudinary method, by calling the cloudinary.config(), or by using the CLOUDINARY_URL environment variable.

Require the Cloudinary library

var cloudinary = require('cloudinary').v2

Overriding the request agent

To override the request agent pass the agent into any method that makes a request and it will be used instead of the normal https agent. e.g

cloudinary.uploader.upload_stream(
  { agent: myAgent },
  function(error, result) { console.log(result); }
);

Embedding and transforming images

Any image uploaded to Cloudinary can be transformed and embedded using powerful view helper methods:

The following example generates the url for accessing an uploaded sample image while transforming it to fill a 100x150 rectangle:

cloudinary.url("sample.jpg", {width: 100, height: 150, crop: "fill"})

Another example, emedding a smaller version of an uploaded image while generating a 90x90 face detection based thumbnail:

cloudinary.url("woman.jpg", {width: 90, height: 90, crop: "thumb", gravity: "face"});

You can provide either a Facebook name or a numeric ID of a Facebook profile or a fan page.

Embedding a Facebook profile to match your graphic design is very simple:

cloudinary.url("billclinton.jpg", {width: 90, height: 130, type: "facebook", crop: "fill", gravity: "north_west"});

Same goes for Twitter:

cloudinary.url("billclinton.jpg", {type: "twitter_name"});

See our documentation for more information about displaying and transforming images in Node.js.

Upload

Assuming you have your Cloudinary configuration parameters defined (cloud_name, api_key, api_secret), uploading to Cloudinary is very simple.

The following example uploads a local JPG to the cloud:

var cloudinary = require('cloudinary').v2;
cloudinary.uploader.upload("my_picture.jpg", function(error, result) { console.log(result) });

Below is an example of an upload's result:

{
  "public_id": "4srvcynxrf5j87niqcx6w",
  "version": 1340625837,
  "signature": "01234567890abcdef01234567890abcdef012345",
  "width": 200,
  "height": 200,
  "format": "jpg",
  "resource_type": "image",
  "url": "http://res.cloudinary.com/demo/image/upload/v1340625837/4srvcynxrf5j87niqcx6w.jpg",
  "secure_url": "https://res.cloudinary.com/demo/image/upload/v1340625837/4srvcynxrf5j87niqcx6w.jpg"
}

The uploaded image is assigned a randomly generated public ID. The image is immediately available for download through a CDN:

cloudinary.url("abcfrmo8zul1mafopawefg.jpg");

// http://res.cloudinary.com/demo/image/upload/abcfrmo8zul1mafopawefg.jpg

You can also specify your own public ID:

cloudinary.uploader.upload(
  "http://www.example.com/image.jpg", 
  {public_id: 'sample_remote'}, 
  function(error, result) { 
    console.log(result) 
  }
);

cloudinary.url("sample_remote.jpg")

// http://res.cloudinary.com/demo/image/upload/sample_remote.jpg

See our documentation for plenty more options of uploading to the cloud from your Node.js code or directly from the browser.

cloudinary.upload_stream

You can use cloudinary.upload_stream to write to the uploader as a stream:

var fs = require('fs');
var stream = cloudinary.uploader.upload_stream(function(error, result) { console.log(result); });
var file_reader = fs.createReadStream('my_picture.jpg', {encoding: 'binary'}).on('data', stream.write).on('end', stream.end);

Version 1.1 upload_stream change notes

The upload_stream method was modified to return a Transform stream object, we advise to change the on('data') and on('end') to pipe API:

var file_reader = fs.createReadStream('my_picture.jpg').pipe(stream);

if you still need to use event chanining, you can wrap stream.write and stream.end with wrapper functions

var file_reader = fs.createReadStream('my_picture.jpg', {encoding: 'binary'})
  .on('data', function(data){stream.write(data)})
  .on('end', function(){stream.end()});

cloudinary.image

Returns an html image tag pointing to Cloudinary.

Usage:

cloudinary.image("sample", {format: "png", width: 100, height: 100, crop: "fill"})

// <img src='http://res.cloudinary.com/demo/image/upload/c_fill,h_100,w_100/sample.png' height='100' width='100'/>

Typescript

🎉New 🎉TypeScript support was just added. Check out the declaration file.

Samples

You can find our simple and ready-to-use samples projects, along with documentation in the samples folder. Please consult with the README file, for usage and explanations.

Additional resources

Additional resources are available at:

Run test

npm run test

Support

You can open an issue through GitHub.

Contact us https://cloudinary.com/contact

Stay tuned for updates, tips and tutorials: Blog, Twitter, Facebook.

Join the Community

Impact the product, hear updates, test drive new features and more! Join here.

License

Released under the MIT license.

Test resources include the video Cloud Book Study which was created by Heidi Neilson and is distributed under the Creative commons - attribution license (CC BY 3.0)

Project Statistics

Sourcerank 14
Repository Size 23.3 MB
Stars 320
Forks 178
Watchers 34
Open issues 51
Dependencies 38
Contributors 28
Tags 45
Created
Last updated
Last pushed

Top Contributors See all

Tal Lev-Ami Amir Tocker Daniel Cohen Nadav Soferman nadavofir strausr Raz Konforti itaibenari RTLcoil igy Naman Goel bompus Eitan Peer Nadav Ofir Rudolf Meijering Laurynas Karvelis Avi Haiat Gavin Trung Lê Oleg Romanovskyi

Packages Referencing this Repo

cloudinary_gs
Cloudinary NPM for node.js integration
Latest release 1.13.2 - Published - 320 stars
cloudinary
Cloudinary NPM for node.js integration
Latest release 1.17.0 - Updated - 320 stars

Recent Tags See all

1.16.0 October 15, 2019
1.15.0 September 08, 2019
1.14.0 March 26, 2019
1.13.2 November 14, 2018
1.13.2 November 14, 2018
1.13.2 November 14, 2018
1.13.1 November 13, 2018
1.13.1 November 13, 2018
1.13.0 November 12, 2018
1.13.0 November 12, 2018
1.13.0 November 12, 2018
1.12.0 November 08, 2018
1.12.0 November 08, 2018
1.11.0 March 19, 2018
1.10.0 February 13, 2018

Interesting Forks See all

CNXTEoEorg/cloudinary_npm
Cloudinary NPM for node.js integration
CoffeeScript - Published - 1 stars
JedWatson/cloudinary_npm
Cloudinary NPM for node.js integration
CoffeeScript - Updated - 1 stars
erlapso/cloudinary_npm
Cloudinary NPM for node.js integration
CoffeeScript - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-11-11 13:39:53 UTC

Login to resync this repository