Skip to content

mayashavin/cloudinary-api

Repository files navigation

Cloudinary tree-shakable API

A set of lighter packages for using Cloudinary

cloudinary-build-url

npm version npm downloads Codecov License

Build URL for images and videos based on configurations.

📖  Documentation

💻  Codebase

✊  Coding coverage status

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

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

console.log(src)

Installation

To use cloudinary-build-url:

npm i cloudinary-build-url

#OR
yarn add cloudinary-build-url

Use with TypeScript

cloudinary-build-url supports 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

Supporting packages

@cld-apis/utils

Constants for transformations used in Cloudinary APIs, and other helper functionalities.

@cld-apis/types

Defined types used in cloudinary-build-url for TypeScript

Vue-cli plugin - vue-cli-plugin-cloudinary-api

Cloudinary API plugin for Vue-cli created projects

Maintained by Maya Shavin