text-compression

Text Compression

Text Compression, metin verilerini sıkıştırıp ve dekomprese edebileceğiniz bir JavaScript kütüphanesidir. Bu kütüphane, metinlerinizi gzip algoritması kullanarak sıkıştırır ve ardından bu sıkıştırılmış veriyi kolayca açmanızı sağlar. Sıkıştırma ve dekompresyon işlemleri asenkron çalışır.

Özellikler

• Sıkıştırma: Verilerinizi gzip algoritması kullanarak sıkıştırır.
• Dekomprese: Sıkıştırılmış verilerinizi kolayca geri açmanızı sağlar.
• Asenkron İletişim: Her iki işlem de Promises kullanarak asenkron bir şekilde gerçekleştirilir.
• Base64 Kodlama: Sıkıştırılmış veriler, base64 formatında döndürülür, böylece verilerinizi kolayca saklayabilir veya iletebilirsiniz.

Kurulum

NPM ile Yükleme

Projeyi kendi projenize dahil etmek için npm kullanabilirsiniz:

npm install text-compression

Yalnızca Dosya Yüklemesi

Alternatif olarak, text-compression.js dosyasını projenize dahil ederek doğrudan kullanabilirsiniz.

Kullanım

Bu kütüphaneyi kullanarak metin sıkıştırma ve dekompresyon işlemlerini gerçekleştirebilirsiniz.

1. Sıkıştırma

Metni sıkıştırmak için compress() fonksiyonunu kullanabilirsiniz:

const { compress } = require('text-compression');

const text = "Bu, sıkıştırılacak bir metindir.";

compress(text)
    .then(compressed => {
        console.log('Sıkıştırılmış metin:', compressed);
    })
    .catch(err => {
        console.error('Sıkıştırma hatası:', err);
    });

Bu, metninizi sıkıştırarak base64 formatında döndürecektir.

2. Dekompresyon

Sıkıştırılmış metni açmak için decompress() fonksiyonunu kullanabilirsiniz:

const { decompress } = require('text-compression');

const compressedText = "31,139,8,0,0,0,...";  

decompress(compressedText)
    .then(decompressed => {
        console.log('Dekompresyon sonucu:', decompressed);
    })
    .catch(err => {
        console.error('Dekompresyon hatası:', err);
    });

Bu, sıkıştırılmış veriyi alacak ve orijinal metni geri döndürecektir.

API

compress(text: string): Promise<string>

Verilen metni sıkıştırır ve base64 formatında döndürür.

Parametreler:

• text (string): Sıkıştırılacak metin.

Dönüş Değeri:

• Promise: Sıkıştırılmış ve base64'e dönüştürülmüş metin.

decompress(compressedText: string): Promise<string>

Verilen base64 formatındaki sıkıştırılmış metni dekomprese eder ve orijinal metni döndürür.

Parametreler:

• compressedText (string): Base64 formatında sıkıştırılmış metin.

Dönüş Değeri:

• Promise: Orijinal, dekomprese edilmiş metin.

Testler

Testler, Jest test çerçevesi kullanılarak yazılmıştır. Testleri çalıştırmak için aşağıdaki komutları kullanabilirsiniz:

Testleri Çalıştırma

npm test

Katkıda Bulunma

Eğer bu projeye katkıda bulunmak isterseniz, aşağıdaki adımları takip edebilirsiniz:

• Bu projeyi fork edin.
• Yeni bir feature branch'ı oluşturun.
• Yaptığınız değişiklikleri commit'leyin.
• Pull request gönderin.