Socket
Socket
Sign inDemoInstall

sharp-image-conversion

Package Overview
Dependencies
86
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

sharp-image-conversion

Sharp.js wrapper for single image resize, quality manipulation and format conversion and output to file or buffer


Version published
Maintainers
1
Weekly downloads
1

Weekly downloads

Readme

Source

Image Conversion Utility (sharp-image-conversion)

Sharp wrapper for single image resize, manipulation and format conversion then output to file or buffer.

Installation

npm install --save sharp-image-conversion

Usage

// instantiate (optional resizing will be applied to all output files/buffered data)
const ImageConverter = require('sharp-image-conversion')
const imageConverter = new ImageConverter('./filename.jpg', {
  xLimit: 1920,
  yLimit: 1080,
})

// convert to PNG and output to disk with specified image manipulation params (only the target path is required)
imageConverter.streamCopy(
  './newFilename.png',
  'png',
  {
    compressionLevel: 5,
    quality: 50,
  })

// convert to webP and output to buffer, with no other alterations
imageConverter
  .toBuffer('webp')
  .then(buffer => {
    // do something with the buffered image data
  })
  .catch(error => {
    console.log(error)
  })

API

new Instance(sourceFilePath : String, resizeOption? : Object)

creates an instance and specify the optional resizing parameter object in the format of:

const resizingOptions = {
  xLimit: 1920, // optional
  yLimit: 1080, // optional
}

Instance.streamCopy(targetFilePath : String, targetFormat? : String, outputOptions? : Object)

copy the file specified during instantiation using node.js stream after converting to the optionally specified image format with optionally appied image manipulation parameters

note 1: refer to Sharp docs for supported image formats.

note 2: specified outputOptions are ignored if targetFormat is undefined or null.

// output options are ignored in this case
instance.streamCopy('targetPath', undefined, {
  option_1: blah_1,
  option_2: blah_2,
})

note 3: outputOptions should match the targetFormat according to Sharp docs.

Instance.toBuffer(targetFormat? : String, outputOptions? : Object)

buffer the image data from the file specified during instantiation after converting to the optionally specified image format with optionally appied image manipulation parameters

see notes from Instance.StreamCopy method

License

MIT

Keywords

FAQs

Last updated on 23 Apr 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc