![\"skaler\"](\"skaler.png\")
\n\n \n
\n \n \n \n \n
![\"gzip](\"http://img.badgesize.io/https://unpkg.com/skaler/dist/skaler.mjs?compression=gzip\")
![\"license\"](\"https://img.shields.io/npm/l/skaler.svg\")
\n \n \n ![\"dependencies\"](\"https://img.shields.io/badge/dependencies-none-ff69b4.svg\"){kind=icon}
\n \n
A 329B client-side image resizer
\n\nSkaler is a simple and small tool to scale images client-side.\nIt's ideal when all you want to do is to scale user submitted images before uploading to your server.\n\nSave storage space, bandwidth and reduce server load by scaling images client side before uploading.\n\n**~~lack of~~ Features**\n- Tiny\n- Vanilla JS\n- Zero Dependencies\n\n\n## Install\n\n```\n$ npm install skaler\n```\n\nThis module exposes two module definitions:\n\n* **ES Module**: `dist/skaler.mjs`\n* **UMD**: `dist/skaler.umd.js`\n\nInclude skaler:\n```js\n// ES6\nimport skaler from 'skaler'\n\n// CJS\nconst skaler = require('skaler');\n```\n\nThe script can also be directly included from [unpkg.com](https://unpkg.com):\n```html\n\n```\n\n\n## Usage\n\n```js\nimport skaler from 'skaler';\n\n/**\n * Assume 'input' is the value coming from an input field:\n * \n */\n\nconst input = document.getElementById('#input').files[0];\n\nconst file = await skaler(input, { scale: 0.5 });\n// ~> resized image as a File object - half the size\n\nconst file = await skaler(input, { width: 300 });\n// ~> resized image as a File object - 300px width\n\nconst file = await skaler(input, { width: 300, height: 500 });\n// ~> resized image as a File object - stretched to 300x500px\n\n```\n\n\n## API\n\n### skaler(file, options={})\nReturns: `File` <_Promise_>\n\nReutnrs promise that resolves to the resized [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) object.\n\n> **Note**:The new files has an updated ` last modified time` property.\n\n#### file\nType: `File`\n\n[`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) object to be resized.\nThis is what input elements of type `file` returns.\n\n> **Note**: The file is expected to be of type image.\n\n#### options.scale\nType: `number`