2.0.0-beta • Published 3 years ago
universal-compress-image v2.0.0-beta
compressImage
Compresses images. Multiple types of compression quality are available.
Supported
Install
$ npm install universal-compressImage --save
or
$ npm install universal-api --save
Usage
import compressImage from 'universal-compressImage';
compressImage({
src: 'http://img.icon.com/a.png',
quality: 1,
success: (res) => {
console.log('success', res);
},
fail: (res) => {
console.log('fail', res);
},
complete: (res) => {
console.log('complete', res);
}
});
// promise
compressImage({
src: 'http://img.icon.com/a.png',
quality: 1
}).then(response => {})
.catch(error => {})
.finally(res => {});
You can also import from the big package:
import { compressImage } from 'universal-api';
Methods
compressImage(options)
Arguments
Property | Type | Description | required | Default |
---|---|---|---|---|
options | object | ✔️ | - | |
opthons.src | string | The path to the image. It can be a relative path, a temporary file path, or a file compress-image path | ✔️ | - |
options.quality | number | Compression quality. The value range is 0-3. | ✘ | - |
options.success | Function | The callback function for a successful API call | ✘ | - |
options.fail | Function | The callback function for a failed API call | ✘ | - |
options.complete | Function | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |
Return
Property | Type | Description |
---|---|---|
tempFilePath | string | The temporary file path to the compressed image |
/**
* iframe: true
*/
import React from 'react';
export default () => (
<iframe style={{
boxShadow: '0 2px 15px rgba(0,0,0,0.1)',
width: '375px',
height: '700px'
}} src='https://herbox.online/p/109000004/app_1aKtEd7SK?previewZoom=100&view=preview&defaultPage=pages/universal-compress-image/index&topSlider=false'></iframe>
);
2.0.0-beta
3 years ago