You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP

upscayl-node

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
u

upscayl-node

Upscale node package based on upscayl

3.1.1
latest
66

Supply Chain Security

100

Vulnerability

94

Quality

81

Maintenance

70

License

Unpopular package

Quality

This package is not very popular.

Found 1 instance in 1 package

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Version published
Weekly downloads
137
-10.46%
Maintainers
0
Weekly downloads
 
Created
Issues
0

Upscayl Node

Upscayl node prepares the UPSCAYL CORE to run in NodeJS.

const { join } = require("path");
const { upscaler } = require("upscayl-node");

const run = async () => {
  const outputImagePath = await upscaler.upscaleImage(
    join(__dirname, "./image-test.png"),
    join(__dirname, "./image-test-result.png")
  );
};

run();

Upscayl definition:

| Free and Open Source AI Image Upscaler

Upscayl lets you enlarge and enhance low-resolution images using advanced AI algorithms. Enlarge images without losing quality. It's almost like magic! 🎩🪄

Original repo: https://github.com/upscayl/upscayl

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

$ npm install upscayl-node

API reference

Methods

upscaler.init(): Promise<"void">

This method allows you to load the default AI models.

upscaler.getModels(): model[]

This method allows you to obtain the path of the models. It is useful if you want to change the default model that upscales the image.

upscaler.addModel(model: Model): Model

This method allows you to add a path where you have a custom model to the list of models.

upscaler.upscaleImage(imagePath, imageOutputPath, options?): Promise<"string">

This method allows you to upscale an image with various custom options.

const { join } = require("path");
const { upscaler } = require("upscayl-node");

const run = async () => {
  // Once we have the upscaler with models loaded we can run it
  const outputImagePath = await upscaler.upscaleImage(
    join(__dirname, "./image-test.png"),       // Absolute path from image to be upscaled
    join(__dirname, "./image-test-result.png") // Absolute path from image upscaled
  );
};

run();

imagePath

Absolute image path of the image to be upscaled. Only png, jpg or webp images are accepted.

imageOutputPath

Absolute image path of the resulting image. You can choose a different image extension, which will change the image format of the original if you wish. Only png, jpg or webp are allowed.

options

PropertyDescriptionTypeDefault
modelAbsolute path of the model used to upscale the image.stringupscaler.getModels()[0]
scaleSpecifies the scale of the resulting image relative to the original image.number2
compressionSet the final image compression.number0
tileSizeDefine the final tile size of the image.number0

FAQs

Package last updated on 29 Dec 2024

Did you know?

Socket

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