Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

upscale-x

zhindev35MIT1.0.0

Image upscaling library using AI enhancement

upscale, image-processing, ai, enhance, remini

readme

UpscaleX 🔄✨

npm version License: MIT

Library peningkatan kualitas gambar menggunakan teknologi AI untuk meningkatkan resolusi dan kualitas gambar.

Fitur 🚀

  • Meningkatkan resolusi gambar
  • Meningkatkan kualitas dan detail gambar
  • Mendukung input berupa file path atau Buffer
  • Format output PNG berkualitas tinggi
  • Ukuran hasil otomatis terhitung

Instalasi 💿

npm install upscalex

Penggunaan Dasar 🧑💻

Menggunakan Path File

import upscale from 'upscalex';
import fs from 'fs';

async function processImage() {
  const result = await upscale('./input.jpg');

  if (result.success) {
    console.log('✅ Peningkatan berhasil!');
    console.log(`📁 Ukuran: ${result.data.size}`);
    fs.writeFileSync('./output.png', result.data.image);
  } else {
    console.error('❌ Gagal:', result.error);
  }
}

processImage();

Menggunakan Buffer

import upscale from 'upscalex';
import fs from 'fs';

// Baca gambar sebagai Buffer
const imageBuffer = fs.readFileSync('./input.jpg');

async function processBuffer() {
  const result = await upscale(imageBuffer);

  if (result.success) {
    fs.writeFileSync('./buffer-output.png', result.data.image);
    console.log('🖼️ URL Hasil:', result.data.imageUrl);
  }
}

processBuffer();

API Reference 📚

upscale(imageInput)

  • imageInput (String | Buffer): Path file gambar atau Buffer
  • Returns: Promise<Object>

Format Response:

{
  success: boolean,      // Status proses
  data: {
    image: Buffer,      // Gambar hasil dalam Buffer
    imageUrl: string,    // URL langsung ke gambar hasil
    size: string        // Ukuran file format (contoh: '4.2MB')
  },
  error?: string        // Pesan error jika gagal
}

Contoh Kasus 🖼️

Handling Error

import upscale from 'upscalex';

async function tryUpscale() {
  try {
    const result = await upscale('invalid-file.jpg');

    if (!result.success) {
      console.error('Error:', result.error);
      return;
    }

    // Proses hasil...
  } catch (error) {
    console.error('Exception:', error.message);
  }
}

tryUpscale();

Persyaratan Sistem ⚙️

  • Node.js 18+
  • Akses internet
  • RAM minimal 512MB

Batasan ⚠️

  • Ukuran gambar maksimal 5MB
  • Format input yang didukung: JPG, PNG
  • Mungkin terdapat delay saat server sibuk

Berkontribusi 🤝

Pull request diterima! Untuk perubahan besar, buka issue terlebih dahulu.

Lisensi 📜

MIT © 2024 Zhindev


Catatan: Library ini menggunakan API pihak ketiga. Gunakan dengan bijak dan sesuai kebijakan layanan. `