imazip v0.2.1

Imazip

Imazip is JavaScript module that compresses images for the front end. Imazip can quickly create a thumbnail image. It is very simple!

Installation

npm install imazip

How to use

Simple to use

import imazip from 'imazip'
// const imazip = require('imazip')

const theImage = document.getElementById('image')

imazip({
  src: './heropy.png',
  format: 'png',
  quality: .7
})
  .then(image => {
    theImage.src = image.origin
  })

When using a FileReader

<input type="file"
       onchange="return onChange(event)">

import imazip from 'imazip'

function onChange(e) {
  const files = e.target.files || e.dataTransfer.files
  const reader = new FileReader()
  
  if (files && files.length > 0) {
    reader.readAsDataURL(files[0])
    reader.onload = () => {
      imazip({
        height: 500,
        src: reader.result,
        format: files[0].type,
        quality: .7,
        thumbnail: {
          maxSize: 200,
          quality: .5
        }
      })
        .then(image => {
          console.log(
            image.origin,  // data:image/jpeg;base64,/9j/4AAQSkZJRgABA...
            image.thumbnail  // data:image/jpeg;base64,/9j/4AAQSkZJRgABA...
          )
        })
    }
  }
}

When using the axios

import imazip from 'imazip'
import axios from 'axios'

function getImage() {
  const url = 'https://avatars3.githubusercontent.com/u/16679082?s=460&v=4'
  axios
    .get(url, {
      responseType: 'arraybuffer'
    })
    .then(response => {
      const type = response.headers['content-type'].toLowerCase()
      const image = btoa(
        new Uint8Array(response.data)
          .reduce((data, byte) => data + String.fromCharCode(byte), ''))

      return {
        src: `data:${type};base64,${image}`,
        type
      }
    })
    .then(image => {
      return imazip({
        src: image.src,
        format: image.type,
        quality: .7,
        thumbnail: {
          maxSize: 200,
          quality: .5
        }
      })
    })
    .then(image => {
      console.log(
        image.origin,  // data:image/jpeg;base64,/9j/4AAQSkZJRgABA...
        image.thumbnail  // data:image/jpeg;base64,/9j/4AAQSkZJRgABA...
      )
    })
}

async/await

Because it return Promise, you can use async/await.

async function asyncFunction() {
  const image = await imazip({
    src: './heropy.png',
    format: 'png'
  })
  someImage.src = image.origin
}

Options

width

• Type: Number,
• Default: null

The width value of the image to be output. Because The aspect ratio is automatically adjusted, It is recommended to enter only one value either width or height. If neither width nor height is entered, the original size is output.

height

• Type: Number,
• Default: null

The height value of the image to be output. Because The aspect ratio is automatically adjusted, It is recommended to enter only one value either width or height. If neither width nor height is entered, the original size is output.

src

• Type: String,
• Default: "",
• Required!

HTML image format supported by <img> element. Information about what image formats the browsers support.

quality

• Type: Number,
• Default: 0.8

A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp.

format

• Type: String,
• Default: image/jpeg

The mime type of the output image such as image/png and image/jpeg. The following 3 formats are supported.

maxSize

• Type: Number,
• Default: 1920

Specifies the largest(max) size of the image to be output. It is based on a larger value, regardless of the horizontal and vertical size of the image. For example, if the value of maxSize is 1200, to ouput 1200x720px image from 2500x1500px image Or to output 720x1200px image from 1500x2500px image.

Please Notes!

maxSize takes precedence over width and height.

imazip({
  width: 3000,
  height: 2500,  // The default value of the maxSize is '1920px'.
  // maxSize: 1920,
  src: 'heropy.jpg'
})
// Output: 1920x1600px image!

If you want to create the desired size, you have to set the value of maxSize.

imazip({
  width: 3000,
  height: 2500,
  maxSize: 3000,
  src: 'heropy.jpg'
})
// Output: 3000x2500px image!

thumbnail

• Type: Object,
• Default: null

Imazip can process a single image while simultaneously creating a thumbnail image of that image. This is useful for distinguishing between image to be saved and image to be displayed. The options for the thumbnail image have the same meaning as above.

To create a thumbnail with default options, enter an empty object.

imazip({
  height: 700,
  src: 'heropy.jpg',  // The default value of the format is 'image/jpeg'.
  // format:  'image/jpeg',
  quality: .4,
  thumbnail: {}
  /** 
  * The value of an empty object in the Thumbnail property is the same as:
  thumbnail: {
    width: undefined,
    height: undefined,
    maxSize: 200,
    quality: .4
    // src: 'heropy.jpg'
    // format: 'image/jpeg' 
  }
  **/
})

thumbnail.width

Sets the width of the thumbnail to be output. In most cases, it is recommended that you only use maxSize without width(height).

• Type: Number,
• Default: undefined

thumbnail.height

Sets the height of the thumbnail to be output. In most cases, it is recommended that you only use maxSize without height(width).

• Type: Number,
• Default: undefined

thumbnail.maxSize

Specifies the largest(max) size of the thumbnail to be output.

• Type: Number,
• Default: 200

thumbnail.quality

A Number between 0 and 1 indicating the image quality to use for image formats that use lossy compression such as image/jpeg and image/webp. If not specified, it is the same as the quality value already entered above.

• Type: Number,
• Default: undefined

filter

Imazip is using ImageFilters for image filters. Thanks to it, you can provide various filters. Just add the name of the filter you want and the options!

• Type: Object,
• Default: null

// If there is no option, specify only the filter name.
imazip({
  src: 'heropy.jpg',
  filter: {
    name: 'GrayScale'
  }
})

// If there is an option, specify it as an array. 
imazip({
  src: 'heropy.jpg',
  filter: {
    name: 'Twril',
    options: [.5, .5, 100, 360, 'Transparent', true]  // centerX, centerY, radius, angle, edge, smooth
  }
})

imazip({
  src: 'heropy.jpg',
  filter: {
    name: 'GaussianBlur',
    options: [4]  // strength
  }
})

name

Select the name of the desired filter.

• Type: String,
• Default: undefined

options

Add options for the selected filter

• Type: Array,
• Default: undefined

Supportable Filters

Test each filter in the ImageFilters Demo.

License

MIT © Heropy

⬆ to top