@cloudinary/url-gen

    1.8.6 • Public • Published

    Cloudinary URL-Gen SDK

    Build Status

    About

    The Cloudinary URL-Gen SDK allows you to quickly and easily integrate your application with Cloudinary. Effortlessly optimize and transform your cloud's assets.

    This SDK can also be used with popular frontend frameworks.

    Additional documentation

    This Readme provides basic installation and usage information. For the complete documentation, see the URL-Gen SDK Guide and the URL-Gen Reference.

    Table of Contents

    Key Features

    Version Support

    Note!

    This SDK is cross-platform, but only the Node.js versions are worth mentioning

    SDK Version Node.js 10 Node.js 12 Node.js 14 Node.js 16
    1.x V V V V

    Installation

    Install using your favorite package manager (yarn, npm)

    npm install @cloudinary/url-gen
    yarn add @cloudinary/url-gen 

    Usage

    Setup

    // Import the Cloudinary class
    import {Cloudinary} from '@cloudinary/url-gen';
    
    // Create your instance
    const cld = new Cloudinary({
      cloud: {
        cloudName: 'demo'
      },
      url: {
        secure: true // force https, set to false to force http
      }
    });

    Transform and Optimize Assets

    // Create a new instance if you haven't (see above for the details)
    const cld = new Cloudinary({/*...*/})
    
    // Let's create a new image
    const myImage = cld.image('sample');
    
    // Import the resize transformation and apply it to myImage
    import {Resize} from '@cloudinary/url-gen/actions/resize';
    
    // Resize the image to 100x100
    myImage.resize(Resize.scale().width(100).height(100));
    
    // When we're done, we can apply all our changes and create a URL.
    const myURL = myImage.toURL();
    
    // https://res.cloudinary.com/demo/image/upload/c_scale,w_100,h_100/sample
    console.log(myURL);

    Generate Image and Video URLs

    The library supports transformations on both images and videos. Please use the appropriate method, as per below:

    - Use `cld.image()` to generate image URLs and transformations
    - Use `cld.video()` to generate video URLs and transformations
    

    Both the image() and video() methods allow you to use toURL() to generate the final, transformed asset URL.

    File upload

    This SDK does not provide file upload functionality, however there are several methods of uploading from the client side.

    Transpilation

    @cloudinary/url-gen is shipped as untranspiled ES6 code. @cloudinary/url-gen is optimized around bundle size, as such we do not transpile our distributed modules, we leave the decision of what browsers to support, and what transpilations to apply, to you, the user.

    Testing with Jest

    As mentioned above, we're shipping @cloudinary/url-gen with ES6 code, as this provides great tree-shaking potential. it also requires a few adjustments when testing.

    In jest.config, you'll need to add these lines to allow babel to transpile our code.

    {
      "transform": {
        "node_modules/@cloudinary/url-gen": "babel-jest"
      },
      "transformIgnorePatterns": ["/node_modules/(?!@cloudinary/url-gen)"]
    }

    Make sure to install babel-jest: npm install babel-jest

    You'll also need to ensure you have a babel.config.js file (and not a .babelrc), and that it's configured properly to transpile code,

    As an example:

    module.exports = {
      "presets": [
        "@babel/preset-env"
      ]
    };

    Contributions

    • Clone this repository
    • Create a fork
    • Make your changes
    • Run tests locally npm run test
    • Build project locally npm run build
    • Push your changes
    • Await a review from the maintainers

    Get Help

    If you run into an issue or have a question, you can either:

    Additional resources can be found here:

    About Cloudinary

    Cloudinary is a powerful media API for websites and mobile apps alike, Cloudinary enables developers to efficiently manage, transform, optimize, and deliver images and videos through multiple CDNs. Ultimately, viewers enjoy responsive and personalized visual-media experiences—irrespective of the viewing device.

    Additional Resources

    Licence

    Released under the MIT license.

    Keywords

    none

    Install

    npm i @cloudinary/url-gen

    DownloadsWeekly Downloads

    32,954

    Version

    1.8.6

    License

    MIT

    Unpacked Size

    1.8 MB

    Total Files

    1003

    Last publish

    Collaborators

    • cloudinary