{"id":15170414,"url":"https://github.com/datsteves/image-optimizer-core","last_synced_at":"2025-10-01T05:30:49.498Z","repository":{"id":57140685,"uuid":"119845914","full_name":"datsteves/image-optimizer-core","owner":"datsteves","description":"This Package optimizes your images by adjusting the quality automatically","archived":true,"fork":false,"pushed_at":"2018-11-04T12:05:06.000Z","size":15761,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-01T05:10:07.269Z","etag":null,"topics":["compression","image-compression","image-optimization","imagemin","jpg","opencv","optimizer","png","webp"],"latest_commit_sha":null,"homepage":"","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/datsteves.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"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":"2018-02-01T14:22:27.000Z","updated_at":"2023-06-12T18:56:23.000Z","dependencies_parsed_at":"2022-09-01T23:50:33.405Z","dependency_job_id":null,"html_url":"https://github.com/datsteves/image-optimizer-core","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsteves%2Fimage-optimizer-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsteves%2Fimage-optimizer-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsteves%2Fimage-optimizer-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsteves%2Fimage-optimizer-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datsteves","download_url":"https://codeload.github.com/datsteves/image-optimizer-core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234827057,"owners_count":18892884,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["compression","image-compression","image-optimization","imagemin","jpg","opencv","optimizer","png","webp"],"created_at":"2024-09-27T08:02:20.451Z","updated_at":"2025-10-01T05:30:43.014Z","avatar_url":"https://github.com/datsteves.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Image Optimizer Core\n\n[![Build Status](https://travis-ci.com/datsteves/image-optimizer-core.svg?branch=master)](https://travis-ci.com/datsteves/image-optimizer-core)\n\nThis Package optimizes your images and adjust the quality automatically.\nSo no standard 80% Quality on your JPEG's.\n\n\n## Install\n\nplease have a look at the instruction of [node-opencv](https://github.com/peterbraden/node-opencv) to install opencv on your machine.\n\n```bash\n$ npm install image-optimizer-core\n# or with yarn\n$ yarn add image-optimizer-core\n```\n\n## Usage\n\n```js\n\nimport optimizer from 'image-optimizer-core'\n// or with the old way\n// const optimizer = require('image-optimizer-core')\n\n\n// using files\noptimizer('path/to/file.jpg')\n    .toFile('output.jpg')\n    .then(saved =\u003e {\n        console.log('I saved you', saved * 100, '%')\n    })\n\n// using Buffer\noptimizer(buffer)\n    .toBuffer()\n    .then(output =\u003e {\n        // ...\n    })\n\n// You even get the saved kb back as a percentage\noptimizer('example.jpg')\n    .toBuffer()\n    .then((buffer, saved) =\u003e {\n        console.log('saved', saved, '%') // 0.72345 ... so it saved you 72.345%\n    })\n\n// or if you want, you can even convert your files\noptimizer('example.png')\n    .toBuffer('image/webp')\n    .then((buffer, saved) =\u003e {\n        console.log('saved', saved, '%') // 0.72345 ... so it saved you 72.345%\n    })\n\n```\n\n## API\n\n### optimizer(input)\n\nReturns `toBuffer` and `toFile`\n\n#### input\n\nType: `Buffer` or `String`\n\n### toBuffer(outputType)\n\nReturns `Promise\u003cBuffer\u003e, \u003csaved\u003e`\n\n### toFile(ouputPath, outputType)\n\nReturns `Promise\u003csaved\u003e`\n\n#### output\n\nType: `String`\n\n#### saved\n\nType: `Float`\n\nThis is the Percentage that this lib safed you in a number between `0-1`\n\n### outputType\n\nType: `String`\n\ncan be `image/jpeg` \u0026 `image/png` \u0026 `image/webp` .\n\nbut be aware, we dont support `JPEG =\u003e PNG`\n\n## Webpack\n\nif you want to have a webpack loader for it, that uses this package then go to [image-optimizer-webpack-loader](https://github.com/datsteves/image-optimizer-webpack-loader).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatsteves%2Fimage-optimizer-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatsteves%2Fimage-optimizer-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatsteves%2Fimage-optimizer-core/lists"}