npmpackage.info

Gathering detailed insights and metrics for @imsourajit/react-native-compressor

@imsourajit/react-native-compressor - 1.6.2 | npmpackage.info

@imsourajit/react-native-compressor

🗜️Compress Image, Video, and Audio same like Whatsapp 🚀✨

1.6.2

1,091

MIT

Kotlin

1.89 kB

686 3.4

Installations

npm install @imsourajit/react-native-compressor

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

19.7.0

NPM Version

9.5.0 Score

44.9

Supply Chain

58.7

Quality

65.2

Maintenance

Vulnerability

93.8

License

Pull Requests

Open

5

Total

112

Closed

5

Merged

102

Issues

Open

40

Total

235

Closed

195

Releases

Release 1.11.0

v1.11.0

Updated on Mar 21, 2025

Release 1.10.5

v1.10.5

Updated on Mar 07, 2025

Release 1.10.4

v1.10.4

Updated on Feb 19, 2025

Release 1.10.3

v1.10.3

Updated on Dec 05, 2024

Release 1.10.2

v1.10.2

Updated on Dec 05, 2024

Release 1.10.1

v1.10.1

Updated on Dec 04, 2024

View All 82 releases

Languages

Kotlin

Swift

TypeScript

Java

Ruby

Objective-C++

JavaScript

Shell

Objective-C

Kotlin (40.07%)

Swift (32.36%)

TypeScript (18.12%)

Java (3.53%)

Ruby (1.63%)

Objective-C++ (1.51%)

JavaScript (1.28%)

Shell (0.79%)

Objective-C (0.68%)

C (0.04%)

Developer

Shobbak

Download Statistics

Total Downloads

686

Last Day

Last Week

Last Month

Last Year

452

GitHub Statistics

MIT License

1,091 Stars

363 Commits

109 Forks

9 Watchers

14 Branches

20 Contributors

Updated on May 13, 2025

Bundle Size

4.51 kB

Minified

1.89 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 20 Contributors

Package Meta Information

Latest Version

1.6.2

Package Id

@imsourajit/react-native-compressor@1.6.2

Unpacked Size

340.72 kB

Size

112.10 kB

File Count

NPM Version

9.5.0

Node Version

19.7.0

Published on

May 22, 2023

Total Downloads

Cumulative downloads

Total Downloads

686

Last Day

Compared to previous day

Last Week

66.7%

Compared to previous week

Last Month

66.7%

Compared to previous month

Last Year

93.2%

452

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Would you like to support me?

react-native-compressor

Compress videos, images and audio before upload

react-native-compressor package is a set of functions that allow you compress Image,Audio and Video

If you find this package useful hit the star 🌟

Open Table of Contents

Installation
- For React Native
  - For React Native<0.65
  - For React Native 0.65 or greater
- Managed Expo
Usage

Other Utilities

Installation

React Native

For React Native<0.65

1yarn add react-native-compressor@rnlessthan65

For React Native 0.65 or greater

1yarn add react-native-compressor

Managed Expo

expo install react-native-compressor

Add the Compressor plugin to your Expo config (app.json, app.config.json or app.config.js):

1{
2  "name": "my app",
3  "plugins": ["react-native-compressor"]
4}

Finally, compile the mods:

expo prebuild

To apply the changes, build a new binary with EAS:

eas build

Automatic linking (for React Native >= 0.60 only)

Automatic linking is supported for both Android and IOS

Linking (for React Native <= 0.59 only)

Note: If you are using react-native version 0.60 or higher you don't need to link this package.

1react-native link react-native-compressor

Manual installation

iOS

In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
Go to node_modules ➜ react-native-compressor and add Compressor.xcodeproj
In XCode, in the project navigator, select your project. Add libCompressor.a to your project's Build Phases ➜ Link Binary With Libraries
Run your project (Cmd+R)<

Android

Open up android/app/src/main/java/[...]/MainActivity.java

Add import com.reactnativecompressor.CompressorPackage; to the imports at the top of the file
Add new CompressorPackage() to the list returned by the getPackages() method

Append the following lines to android/settings.gradle:

include ':react-native-compressor'
project(':react-native-compressor').projectDir = new File(rootProject.projectDir,'../node_modules/react-native-compressor/android')

Insert the following lines inside the dependencies block in android/app/build.gradle:
```
  compile project(':react-native-compressor')
```

Usage

Image

Automatic Image Compression Like Whatsapp

1import { Image } from 'react-native-compressor';
2
3const result = await Image.compress('file://path_of_file/image.jpg', {
4  compressionMethod: 'auto',
5});

Here is this package comparison of images compression with WhatsApp

Manual Image Compression

1import { Image } from 'react-native-compressor';
2
3const result = await Image.compress('file://path_of_file/image.jpg', {
4  maxWidth: 1000,
5  quality: 0.8,
6});

Video

Automatic Video Compression Like Whatsapp

1import { Video } from 'react-native-compressor';
2
3const result = await Video.compress(
4  'file://path_of_file/BigBuckBunny.mp4',
5  {
6    compressionMethod: 'auto',
7  },
8  (progress) => {
9    if (backgroundMode) {
10      console.log('Compression Progress: ', progress);
11    } else {
12      setCompressingProgress(progress);
13    }
14  }
15);

Here is this package comparison of video compression with WhatsApp

Manual Video Compression

1import { Video } from 'react-native-compressor';
2
3const result = await Video.compress(
4  'file://path_of_file/BigBuckBunny.mp4',
5  {},
6  (progress) => {
7    if (backgroundMode) {
8      console.log('Compression Progress: ', progress);
9    } else {
10      setCompressingProgress(progress);
11    }
12  }
13);

Cancel Video Compression

1import { Video } from 'react-native-compressor';
2
3let cancellationVideoId = '';
4
5const result = await Video.compress(
6  'file://path_of_file/BigBuckBunny.mp4',
7  {
8    compressionMethod: 'auto',
9    // getCancellationId for get video id which we can use for cancel compression
10    getCancellationId: (cancellationId) =>
11      (cancellationVideoId = cancellationId),
12  },
13  (progress) => {
14    if (backgroundMode) {
15      console.log('Compression Progress: ', progress);
16    } else {
17      setCompressingProgress(progress);
18    }
19  }
20);
21
22// we can cancel video compression by calling cancelCompression with cancel video id which we can get from getCancellationId function while compression
23Video.cancelCompression(cancellationVideoId);

Audio

1import { Audio } from 'react-native-compressor';
2
3const result = await Audio.compress(
4  'file://path_of_file/file_example_MP3_2MG.mp3',
5  { quality: 'medium' }
6);

Background Upload

1import { backgroundUpload } from 'react-native-compressor';
2
3const headers = {};
4
5const uploadResult = await backgroundUpload(
6  url,
7  fileUrl,
8  { httpMethod: 'PUT', headers },
9  (written, total) => {
10    console.log(written, total);
11  }
12);

API

Image

ImageCompressor

compress(value: string, options?: CompressorOptions): Promise<string>

Compresses the input file URI or base-64 string with the specified options. Promise returns a string after compression has completed. Resizing will always keep the original aspect ratio of the image, the maxWidth and maxHeight are used as a boundary.

CompressorOptions

compressionMethod: compressionMethod (default: "manual")

if you want to compress images like whatsapp then make this prop auto. Can be either manual or auto, defines the Compression Method.
maxWidth: number (default: 1280)

The maximum width boundary used as the main boundary in resizing a landscape image.
maxHeight: number (default: 1280)

The maximum height boundary used as the main boundary in resizing a portrait image.
quality: number (default: 0.8)

The quality modifier for the JPEG file format, can be specified when output is PNG but will be ignored.
input: InputType (default: uri)

Can be either uri or base64, defines the contentents of the value parameter.
output: OutputType (default: jpg)

Can be either jpg or png, defines the output image format.
returnableOutputType: ReturnableOutputType (default: uri)

Can be either uri or base64, defines the Returnable output image format.

Video

compress(url: string, options?: videoCompresssionType , onProgress?: (progress: number)): Promise<string>
cancelCompression(cancellationId: string): void

we can get cancellationId from getCancellationId which is the callback method of compress method options

videoCompresssionType

compressionMethod: compressionMethod (default: "manual")

if you want to compress videos like whatsapp then make this prop auto. Can be either manual or auto, defines the Compression Method.
maxSize: number (default: 640)

The maximum size can be height in case of portrait video or can be width in case of landscape video.
bitrate: string

bitrate of video which reduce or increase video size. if compressionMethod will auto then this prop will not work
minimumFileSizeForCompress: number (default: 16)

16 means 16mb. default our package do not compress under 16mb video file. minimumFileSizeForCompress will allow us to change this 16mb offset. fixed #26
getCancellationId: function

getCancellationId is a callback function that gives us compress video id, which can be used in Video.cancelCompression method to cancel the compression

Audio

compress(url: string, options?: audioCompresssionType): Promise<string>

audioCompresssionType

quality: qualityType (default: medium)
we can also control bitrate through quality. qualityType can be low | medium | high

Note: Audio compression will be add soon

Background Upload

`backgroundUpload: (url: string, fileUrl: string, options: FileSystemUploadOptions, onProgress?: ((writtem: number, total: number) => void) | undefined) => Promise
FileSystemUploadOptions

1type FileSystemUploadOptions = (
2  | {
3      uploadType?: FileSystemUploadType.BINARY_CONTENT,
4    }
5  | {
6      uploadType: FileSystemUploadType.MULTIPART,
7      fieldName?: string,
8      mimeType?: string,
9      parameters?: Record<string, string>,
10    }
11) & {
12  headers?: Record<string, string>,
13  httpMethod?: FileSystemAcceptedUploadHttpMethod,
14  sessionType?: FileSystemSessionType,
15};

Get Metadata Of Video

if you want to get metadata of video than you can use this function

1import { getVideoMetaData } from 'react-native-compressor';
2
3const metaData = await getVideoMetaData(filePath);

{
	"duration": "6",
	"extension": "mp4",
	"height": "1080",
	"size": "16940.0",
	"width": "1920"
}

getVideoMetaData(path: string)

Get Real Path

if you want to convert

content:// to file:/// for android
ph:// to file:/// for IOS

the you can you getRealPath function like this

1import { getRealPath } from 'react-native-compressor';
2
3const realPath = await getRealPath(fileUri, 'video'); //   file://file_path.extension

getRealPath(path: string, type: string = 'video'|'image')

Get Temp file Path

if you wanna make random file path in cache folder then you can use this method like this

1import { generateFilePath } from 'react-native-compressor';
2
3const randomFilePathForSaveFile = await generateFilePath('mp4'); //   file://file_path.mp4

generateFilePath(fileextension: string)

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Maintained

Determines if the project is "actively maintained".

8

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-android.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-android.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-android.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-android.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-ios.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-ios.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-ios.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-ios.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-ios.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-ios.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-ios.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-ios.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-ios.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/build-ios.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/first-issue-or-pr.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/first-issue-or-pr.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sponsor.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/sponsor.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale-bot.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/stale-bot.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-android.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-android.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-android.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-android.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-android.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/validate-android.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-android.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-js.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-js.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/validate-js.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-js.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-js.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-js.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate-js.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/numandev1/react-native-compressor/validate-js.yml/main?enable=pin
Info: 0 out of 16 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 6 third-party GitHubAction dependencies pinned

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

54 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-2rxp-v6pw-ch6m
Warn: Project is vulnerable to: GHSA-4xqq-m2hx-25v8
Warn: Project is vulnerable to: GHSA-5866-49gr-22v4
Warn: Project is vulnerable to: GHSA-r55c-59qm-vjw6
Warn: Project is vulnerable to: GHSA-vg3r-rm7w-2xgh
Warn: Project is vulnerable to: GHSA-vmwr-mc7x-5vc3
Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-rxrc-rgv4-jpvx
Warn: Project is vulnerable to: GHSA-pmgm-h3cc-m4hj
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-3q56-9cc2-46j4
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh
Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-c2jc-4fpr-4vhg
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-cchq-frgv-rjh5
Warn: Project is vulnerable to: GHSA-g644-9gfx-q4q4
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7

Score

3.4

/10

Last Scanned on 2025-05-12

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@imsourajit/react-native-compressor

Installations

Developer Guide

Yes

CommonJS

19.7.0

9.5.0

Score

Pull Requests

5

112

5

102

Issues

40

235

195

Releases

Languages

Developer

Shobbak

Download Statistics

GitHub Statistics

Bundle Size

4.51 kB

1.89 kB

Maintainers

Package Meta Information

Total Downloads

686

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

Would you like to support me?

react-native-compressor

Table of Contents

Installation

React Native

For React Native<0.65

For React Native 0.65 or greater

Managed Expo

Automatic linking (for React Native >= 0.60 only)

Linking (for React Native <= 0.59 only)

Manual installation

iOS

Android

Usage

Image

Automatic Image Compression Like Whatsapp

Manual Image Compression

Video

Automatic Video Compression Like Whatsapp

Manual Video Compression

Cancel Video Compression

Audio

Background Upload

API

Image

ImageCompressor

compress(value: string, options?: CompressorOptions): Promise<string>

CompressorOptions

compressionMethod: compressionMethod (default: "manual")

maxWidth: number (default: 1280)

maxHeight: number (default: 1280)

quality: number (default: 0.8)

input: InputType (default: uri)

output: OutputType (default: jpg)

returnableOutputType: ReturnableOutputType (default: uri)

Video

compress(url: string, options?: videoCompresssionType , onProgress?: (progress: number)): Promise<string>

cancelCompression(cancellationId: string): void

videoCompresssionType

compressionMethod: compressionMethod (default: "manual")

maxSize: number (default: 640)

bitrate: string

minimumFileSizeForCompress: number (default: 16)

getCancellationId: function

Audio

`compress(value: string, options?: CompressorOptions): Promise<string>`

`compressionMethod: compressionMethod` (default: "manual")

`maxWidth: number` (default: 1280)

`maxHeight: number` (default: 1280)

`quality: number` (default: 0.8)

`input: InputType` (default: uri)

`output: OutputType` (default: jpg)

`returnableOutputType: ReturnableOutputType` (default: uri)

`compress(url: string, options?: videoCompresssionType , onProgress?: (progress: number)): Promise<string>`

`cancelCompression(cancellationId: string): void`

`compressionMethod: compressionMethod` (default: "manual")

`maxSize: number` (default: 640)

`bitrate: string`

`minimumFileSizeForCompress: number` (default: 16)

`getCancellationId: function`

`compress(url: string, options?: audioCompresssionType): Promise<string>`

`quality: qualityType` (default: medium)

`FileSystemUploadOptions`

`getVideoMetaData(path: string)`

`getRealPath(path: string, type: string = 'video'|'image')`

`generateFilePath(fileextension: string)`