{"id":34721635,"url":"https://github.com/cloudinary/js-url-builder","last_synced_at":"2026-05-25T03:37:16.723Z","repository":{"id":38370522,"uuid":"497645132","full_name":"cloudinary/js-url-builder","owner":"cloudinary","description":null,"archived":false,"fork":false,"pushed_at":"2023-06-23T22:09:42.000Z","size":652,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-04-13T09:18:10.113Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudinary.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-29T16:26:00.000Z","updated_at":"2022-05-30T13:54:23.000Z","dependencies_parsed_at":"2022-08-09T03:15:48.759Z","dependency_job_id":null,"html_url":"https://github.com/cloudinary/js-url-builder","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/cloudinary/js-url-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Fjs-url-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Fjs-url-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Fjs-url-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Fjs-url-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudinary","download_url":"https://codeload.github.com/cloudinary/js-url-builder/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudinary%2Fjs-url-builder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33459701,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-25T02:24:28.008Z","status":"ssl_error","status_checked_at":"2026-05-25T02:23:23.339Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-25T01:48:25.386Z","updated_at":"2026-05-25T03:37:16.717Z","avatar_url":"https://github.com/cloudinary.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Cloudinary url-builder SDK\n=========================\n[![Build Status](https://api.travis-ci.com/cloudinary/js-url-builder.svg?branch=master)](https://app.travis-ci.com/github/cloudinary/js-url-builder)\n## About\nThe Cloudinary js-url-builder SDK allows you to quickly and easily integrate your application with Cloudinary.\nEffortlessly optimize and transform your cloud's assets.\n\nThis SDK can also be used with [popular frontend frameworks](https://cloudinary.com/documentation/sdks/js/frontend-frameworks/index.html).\n\n### Additional documentation\nThis Readme provides basic installation and usage information.\nFor the complete documentation, see the [url-builder SDK Guide](https://cloudinary.com/documentation/javascript_integration) and the [url-builder Reference](https://cloudinary.com/documentation/sdks/js/url-builder/index.html).\n\n\n## Table of Contents\n- [Key Features](#key-features)\n- [Version Support](#Version-Support)\n- [Installation](#installation)\n- [Usage](#usage)\n    - [Setup](#Setup)\n    - [Transform and Optimize Assets](#Transform-and-Optimize-Assets)\n    - [Generate Image and Video URLs](#Generate-Image-and-Video-URLs)\n    - [Transpilation](#Transpilation)\n    - [Testing with Jest](#Testing-with-jest)\n- [Contributions](#Contributions)\n- [Get Help](#Get-Help)\n- [Additional Resources](#Additional-Resources)\n\n## Key Features\n- [Transform image](https://cloudinary.com/documentation/javascript_image_transformations) assets (links to docs).\n- [Transform video](https://cloudinary.com/documentation/javascript_video_transformations) assets (links to docs).\n\n\n## Version Support\n\n### Note!\nThis SDK is cross-platform, but only the Node.js versions are worth mentioning\n\n| SDK Version   | Node.js 10    | Node.js 12  | Node.js 14   | Node.js 16  |\n|---------------|------------|----------|----------|----------|\n|  1.x          | V          | V        | V        | V        |\n\n\n\n## Installation\n### Install using your favorite package manager (yarn, npm)\n```bash\nnpm install @cloudinary/url-builder\n```\n```bash\nyarn add @cloudinary/url-builder \n```\n\n## Usage\n### Setup\n```javascript\n// Import the Cloudinary class\nimport {Cloudinary} from '@cloudinary/url-builder';\n\n// Create your instance\nconst cld = new Cloudinary({\n  cloud: {\n    cloudName: 'demo'\n  }\n});\n```\n\n### Transform and Optimize Assets\n- [See full documentation](https://cloudinary.com/documentation/javascript_image_transformations)\n```javascript\n// Create a new instance if you haven't (see above for the details)\nconst cld = new Cloudinary({/*...*/})\n\n// Let's create a new image\nconst myImage = cld.image('sample');\n\n// Import the resize transformation and apply it to myImage\nimport {Resize} from '@cloudinary/transformation-builder-sdk/actions/resize';\n\n// Resize the image to 100x100\nmyImage.resize(Resize.scale().width(100).height(100));\n\n// When we're done, we can apply all our changes and create a URL.\nconst myURL = myImage.toURL();\n\n// https://demo.media.cloudinary.net/c_scale,w_100,h_100/sample\nconsole.log(myURL);\n```\n\n### Generate Image and Video URLs\nThe library supports transformations on both images and videos. Please use the appropriate method, as per below:\n\n    - Use `cld.image()` to generate image URLs and transformations\n    - Use `cld.video()` to generate video URLs and transformations\n\nBoth the `image()` and `video()` methods allow you to use `toURL()` to generate the final, transformed asset URL.\n\n### File upload\nThis SDK does not provide file upload functionality, however there are [several methods of uploading from the client side](https://cloudinary.com/documentation/javascript_image_and_video_upload).\n\n### Transpilation\n`@cloudinary/url-builder` is shipped as untranspiled ES6 code.\n`@cloudinary/url-builder` is optimized around bundle size, as such we do not transpile our distributed modules,\nwe leave the decision of what browsers to support, and what transpilations to apply, to you, the user.\n\n### Testing with Jest\nAs mentioned above, we're shipping `@cloudinary/url-builder` with ES6 code, as this provides great tree-shaking potential.\nit also requires a few adjustments when testing.\n\nIn jest.config, you'll need to add these lines to allow babel to transpile our code.\n```json\n{\n  \"transform\": {\n    \"node_modules/@cloudinary/url-builder\": \"babel-jest\"\n  },\n  \"transformIgnorePatterns\": [\"/node_modules/(?!@cloudinary/url-builder)\"]\n}\n```\nMake sure to install babel-jest:\n`npm install babel-jest`\n\nYou'll also need to ensure you have a `babel.config.js` file (and not a `.babelrc`), and that\nit's configured properly to transpile code,\n\n*As an example*:\n```js\nmodule.exports = {\n  \"presets\": [\n    \"@babel/preset-env\"\n  ]\n};\n```\n\n## Contributions\n- Clone this repository\n- Create a fork\n- Make your changes \n- Run tests locally `npm run test` \n- Build project locally `npm run build`\n- Push your changes\n- Await a review from the maintainers \n\n\n## Get Help\nIf you run into an issue or have a question, you can either:\n- [Open a Github issue](https://github.com/cloudinary/js-url-builder/issues) (for issues related to the SDK)\n- [Open a support ticket](https://cloudinary.com/contact) (for issues related to your account)\n\nAdditional resources can be found here:\n- [Getting started](https://cloudinary.com/documentation/sdks/js/url-builder/tutorial-gettingStarted.html)\n- [Annotated Code Examples](https://cloudinary.com/documentation/sdks/js/url-builder/tutorial-annotatedExamples.html)\n- [Setup \u0026 Configuration](https://cloudinary.com/documentation/sdks/js/url-builder/tutorial-configuration_.html)\n\n\n## About Cloudinary\nCloudinary 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.\n\n\n## Additional Resources\n- [React SDK](https://www.npmjs.com/package/@cloudinary/react)\n- [Angular SDK](https://www.npmjs.com/package/@cloudinary/angular)\n- [Use with a Frontend Framework](https://cloudinary.com/documentation/sdks/js/frontend-frameworks/index.html)\n- [Cloudinary Transformation and REST API References](https://cloudinary.com/documentation/cloudinary_references): Comprehensive references, including syntax and examples for all SDKs.\n- [MediaJams.dev](https://mediajams.dev/): Bite-size use-case tutorials written by and for Cloudinary Developers\n- [DevJams](https://www.youtube.com/playlist?list=PL8dVGjLA2oMr09amgERARsZyrOz_sPvqw): Cloudinary developer podcasts on YouTube.\n- [Cloudinary Academy](https://training.cloudinary.com/): Free self-paced courses, instructor-led virtual courses, and on-site courses.\n- [Code Explorers and Feature Demos](https://cloudinary.com/documentation/code_explorers_demos_index): A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.\n- [Cloudinary Roadmap](https://cloudinary.com/roadmap): Your chance to follow, vote, or suggest what Cloudinary should develop next.\n- [Cloudinary Facebook Community](https://www.facebook.com/groups/CloudinaryCommunity): Learn from and offer help to other Cloudinary developers.\n- [Cloudinary Account Registration](https://cloudinary.com/users/register/free): Free Cloudinary account registration.\n- [Cloudinary Website](https://cloudinary.com)\n\n\n## Licence\nReleased under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudinary%2Fjs-url-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudinary%2Fjs-url-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudinary%2Fjs-url-builder/lists"}