https://github.com/mayashavin/cloudinary-api

Shorter and lighter APIs for Cloudinary
https://github.com/mayashavin/cloudinary-api

cloudinary cloudinary-api cloudinary-sdk image images javascript video videos

Last synced: 3 months ago
JSON representation

Shorter and lighter APIs for Cloudinary

• Host: GitHub
• URL: https://github.com/mayashavin/cloudinary-api
• Owner: mayashavin
• License: mit
• Created: 2020-11-13T06:13:46.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-21T21:30:57.000Z (almost 2 years ago)
• Last Synced: 2024-11-09T18:48:07.449Z (3 months ago)
• Topics: cloudinary, cloudinary-api, cloudinary-sdk, image, images, javascript, video, videos
• Language: TypeScript
• Homepage: https://cloudinary-build-url.netlify.app/
• Size: 1.66 MB
• Stars: 49
• Watchers: 3
• Forks: 9
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cloudinary tree-shakable API

> A set of lighter packages for using Cloudinary

## `cloudinary-build-url`

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Codecov][codecov-src]][codecov-href]

[![License][license-src]][license-href]

Build URL for images and videos based on configurations.

[📖  Documentation](https://cloudinary-build-url.netlify.app)

[💻  Codebase](https://github.com/mayashavin/cloudinary-api/tree/main/packages/url)

[✊  Coding coverage status](https://mayashavin.github.io/cloudinary-api/)

```

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`:

```bash

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.

```bash

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](https://github.com/mayashavin)

[npm-version-src]: https://img.shields.io/npm/v/cloudinary-build-url/latest.svg

[npm-version-href]: https://npmjs.com/package/cloudinary-build-url

[npm-downloads-src]: https://img.shields.io/npm/dt/cloudinary-build-url.svg

[npm-downloads-href]: https://npmjs.com/package/cloudinary-build-url

[codecov-src]: https://codecov.io/gh/mayashavin/cloudinary-api/branch/main/graph/badge.svg?token=S8V8GIDYPC

[codecov-href]: https://codecov.io/gh/mayashavin/cloudinary-api

[license-src]: https://img.shields.io/npm/l/cloudinary-build-url.svg

[license-href]: https://npmjs.com/package/cloudinary-build-url