cloudinary-build-url

Lighter Url generator for Cloudinary

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cloudinary-build-url
41110.2.4a year ago2 years agoMinified + gzip package size for cloudinary-build-url in KB

Readme

cloudinary-build-url
Netlify Status !npm versionnpm-version-srcnpm-version-href !npm downloadsnpm-downloads-srcnpm-downloads-href !Codecovcodecov-srccodecov-href !Licenselicense-srclicense-href
Cloudinary URL Builder(https://cloudinary-build-url.netlify.app)
The lighter URL builder API for Cloudinary with all features in TypeScript.

By default, f_auto (auto format per browser) and q_auto (auto quality per device) are enabled. And all the urls are generated as secured HTTPS format, unless user states otherwise.
📖 Documentation

Installation

yarn add cloudinary-build-url

or
npm i cloudinary-build-url

Use with TypeScript

In order to start using the lib with TypeScript, please install @cld-apis/types as devDependencies.
npm i -D @cld-apis/types

#OR

yarn add -D @cld-apis/types

Usage

Build a delivery url for image

import { buildUrl } from 'cloudinary-build-url'

const src = buildUrl('example', {
  cloud: {
    cloudName: 'demo',
  },
  transformations: {
    resize: {
      type: 'scale',
      width: 500,
      height: 500,
    }
  }
})

console.log(src)

Or
import { setConfig, buildUrl } from 'cloudinary-build-url'

// Set configuration for Cloudinary
setConfig({
  cloudName: 'demo'
})

// Build URL
const src = buildUrl('example', {
  transformations: {
    resize: {
      type: 'scale',
      width: 500,
      height: 500,
    }
  }
})

console.log(src)

Build a delivery URL for video

import { buildVideoUrl } from 'cloudinary-build-url'

const src = buildVideoUrl('dog', {
  cloud: {
    cloudName: 'demo',
  },
  transformations: {
    resize: {
      type: 'scale',
      width: 500,
      height: 500,
    }
  }
})

console.log(src)