https://github.com/orbitturner/orbit-encoder
A versatile library that efficiently encodes and compresses diverse data inputs into concise strings.
https://github.com/orbitturner/orbit-encoder
compression encoder-decoder
Last synced: 3 months ago
JSON representation
A versatile library that efficiently encodes and compresses diverse data inputs into concise strings.
- Host: GitHub
- URL: https://github.com/orbitturner/orbit-encoder
- Owner: orbitturner
- License: gpl-3.0
- Created: 2022-04-12T11:47:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-23T17:39:29.000Z (over 1 year ago)
- Last Synced: 2025-04-22T14:22:08.299Z (3 months ago)
- Topics: compression, encoder-decoder
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/orbit-encoder
- Size: 1.45 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🟢 ORBIT ENCODER ⚙️🗜️
[](https://github.com/orbitturner/ORBIT-ENCODER)
[](https://github.com/orbitturner/ORBIT-ENCODER)
[](https://github.com/orbitturner/ORBIT-ENCODER)
[](https://github.com/orbitturner/ORBIT-ENCODER)
[](https://github.com/orbitturner/ORBIT-ENCODER) [](https://github.com/orbitturner/ORBIT-ENCODER)
**ORBIT-ENCODER** is an utility library for Data Compression and Encoding. It can take whatever object you give him as argument and returns a compressed encoded string. It provides a decoding method too. It uses a modified version of [*LZString*](https://www.npmjs.com/package/lz-string) for UTF16 Compression.
INSTALLATION
___
## 📚 Table Of Contents 📑
- [🟢 ORBIT ENCODER ⚙️🗜️](#orbit-encoder)
* [📚 Table Of Contents 📑](#table-of-contents)
* [💨 What is this Library for? 🤔](#what-is-this-library-for)
* [✨ Key Features 🎯](#key-features---)
* [📥 HOW TO RUN IT ? 🔰](#how-to-run-it)
* [🤔 HOW IT WORKS ? 🤔](#how-it-works)
+ [➤ Encode & Decode Given Data 🟢](#encode---decode-given-data)
* [Configuration Options](#configuration-options)
* [Contributing ❤](#contributing--)
* [Issue Reporting](#issue-reporting)
* [GREETINGS](#greetings)
* [Author](#author)
* [License](#license)
___
## 💨 What is this Library for? 🤔
**ORBIT-ENCODER** is a small library that is useful for Encoding Objects [`String, Arrays, JSON, Anything...`] to a `Compressed UTF16` String. You can also Decode that string back using The exposed **Decode** method.
> **Note:** This library can only be used with JS or TS but you already know that 🤦🏿♂️.
## ✨ Key Features 🎯
* Use it **without `instantiation`** because all the methods are `Static`.
* **Fast and High Performance Compression** of big Complex Data.
* ✅ TOO EASY TO USE !! 🥳🥳
___
## 📥 HOW TO RUN IT ? 🔰
```bash
# installation with npm
npm install array-querier
# or you may prefer
npm i --save array-querier
# installation with yarn
yarn add array-querier
```
**This SCRIPT relies on NOTHING SO YOU DON'T NEED ADDITIONNAL PACKAGES.**
___
## 🤔 HOW IT WORKS ? 🤔
You only need to Import the ***OrbitEncoder*** Class from the Package and start using it !
### ➤ Encode & Decode Given Data 🟢
If you have a User object as follows ->
```json
const User = {
"name": "Orbit",
"age": 21,
"planet": {
"id": 4,
"codename" : "Shadow-Coders",
"galaxyName" : "Turner"
}
}
```
👇🏾 Let's Encode and Decode an Objects :
- **ECMAScript Modules and Typescript**
```typescript
import {OrbitEncoder} from 'orbit-encoder/lib/OrbitEncoder';
// Then Encode whatever you want
const encodedData = OrbitEncoder.encode(User);
console.log(encodedData);
/**
* 👇🏾 Output: 👇🏾
*
* ᓢ㰴䅼ী甤〦恩Ìߐዠᔣᣡ䂦TɈ〦⁐䰠ᘡ㐢〪僠㲪␠祶fĂ⓸Ǹ͚ࣣគⵉM䀼䀻什䁕㒘攈ᢸ吰ৣ乩厖亰æၩ䩴¸椮ࠢ昤怪挑䃒塐恬睂䤣&㉀PƘ䀠
*
* /
```
```typescript
...
const decodedData = OrbitEncoder.decode(encodedData);
console.log(decodedData);
/**
* 👇🏾 Output: 👇🏾
*
* {
name: 'Orbit',
age: 21,
planet: { id: 4, codename: 'Shadow-Coders', galaxyName: 'Turner' }
}
*
* /
```
**🛑 ANGULAR & FRONTEND USERS ☢️**
> **Note:** If you are using this in your frontend application you'll need to add the folowing line in your `index.html` 👇🏾:.
```html
if (global === undefined) { var global = window; }
```
> **FIX COMING:** We are working on Future updates that will try to fix this error [*Uncaught ReferenceError: global is not defined*].
- **CommonJs and Vanilla JS**
```javascript
const orbit = require("orbit-encoder").OrbitEncoder;
const data = orbit.encode('Bodio Bodio Yei !!');
console.log(data); // 🚀 Output :ᅢ汇njࢀ甠瀼橪梸恕<Ұᡠ⢠ୀ
console.log(orbit.decode(data));
```
> **⚠ Note: ⚠** * You can do that : const orbit = require("orbit-encoder"); And use orbit.OrbitEncoder.encode() everywhere but for a more clean approach I did the code above.
### ➤ Encode & Decode Data Passed on URI 🟢
Sometimes you may want to pass some heavy and complex data or datastructure in a URL, so you can use the `encodeWithURIsafe` method. It produces ASCII strings representing the original string encoded in Base64 with a few tweaks to make these URI safe. Hence, you can send them to the server without thinking about URL encoding them.
This saves bandwidth and CPU.
- **ECMAScript Modules and Typescript**
```typescript
import {OrbitEncoder} from 'orbit-encoder/lib/OrbitEncoder';
const data = [['2021-03-02','2021-06-02'],['2022-05-05','2021-07-01']];
// Then Encode whatever you want
const encodedData = OrbitEncoder.encodeWithURIsafe(data);
console.log(dataForURI);
/**
* 👇🏾 Output: 👇🏾
*
* OoRgzglgsgVgggTygZQAwHcoI1CBJMPGPTGAUQBcoARATSurwgA1kAPAIyJNjwYFUBEADIBhPEkZthAFTgBmWXDZ4ANiAAmQA
*
* /
```
```typescript
...
const decodedData = OrbitEncoder.decodeURIsafe(encodedData);
console.log(decodedData);
/**
* 👇🏾 Output: 👇🏾
*
* [ [ '2021-03-02', '2021-06-02' ], [ '2022-05-05', '2021-07-01' ] ]
*
* /
```
- **CommonJs and Vanilla JS**
```javascript
const orbit = require("orbit-encoder").OrbitEncoder;
const dataForURI = orbit.encodeWithURIsafe([['2021-03-02','2021-06-02'],['2022-05-05','2021-07-01']]);
console.log(dataForURI) // 🚀 Output : OoRgzglgsgVgggTygZQAwHcoI1CBJMPGPTGAUQBcoARATSurwgA1kAPAIyJNjwYFUBEADIBhPEkZthAFTgBmWXDZ4ANiAAmQA
console.log(orbit.decodeURIsafe(dataForURI))
```
___
## Configuration Options
*Coming Soon !*
___
## Contributing ❤
👋🏾 Pull requests are welcome!
___
## Issue Reporting
If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](mailto:[email protected]) details the procedure for disclosing security issues.
___
## GREETINGS
❤❤
❤❤
___
## Author
[Orbit Turner](https://orbitturner.com)
___
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.
______________________________________________________
**❤ MADE WITH LOVE ❤**
