https://github.com/r48n34/chimpers

🙈 A nodejs library to Hide files / zip / images in text by hidden.
https://github.com/r48n34/chimpers

html nodejs steganography

Last synced: about 1 month ago
JSON representation

🙈 A nodejs library to Hide files / zip / images in text by hidden.

• Host: GitHub
• URL: https://github.com/r48n34/chimpers
• Owner: r48n34
• Created: 2022-12-15T10:05:31.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-31T04:09:08.000Z (over 1 year ago)
• Last Synced: 2024-11-10T04:49:20.568Z (3 months ago)
• Topics: html, nodejs, steganography
• Language: TypeScript
• Homepage: https://chimpers-web.vercel.app/
• Size: 326 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# chimpers  

A nodejs library that Hide files / zip / images in text by hidden format.



  





[Web Demo](https://chimpers-web.vercel.app/) | [chimpers npm](https://www.npmjs.com/package/chimpers) | [chimpers-web npm](https://www.npmjs.com/package/chimpers-web) | [Github](https://github.com/r48n34/chimpers)

## Install 

```bash

npm i chimpers

yarn add chimpers

```

## Notices

1. Hidden file is not encrypted currently. 

2. Do not attempt to hide large size file.

3. Single file that smaller than 4kb is recommended.

## Usage

```ts

import { addFileInText, decodeFile } from "chimpers"

import path from "path";

( async () => {

    const filePath = path.join(__dirname, "yo.zip")

    // Add files to text

    const text = addFileInText(

        "hello mate I am peter.", // Text to add files

        filePath,                 // Your txt / zip / file ... locations

        { copyToBoard: false }     // Optional: Will regarding text copy to your clipboard

    );

    

    // Decode regarding text

    await decodeFile(

        text,          // Encoded text string

        "hello",       // Output file name

        __dirname      // Output file path

    );

})()

```

## Utilis

```ts

// Hide files in text

function addFileInText(

    text: string,                 

    file_path: string,

    option?: AddFileInTextOptions

): string 

interface AddFileInTextOptions{

    copyToBoard?: boolean

}

```

```ts

// Decode hidden text and output a file

async function decodeFile(

    encodedText: string, 

    outputFileName: string = "decodedFile", 

    outputPath: string = process.cwd()

): Promise 

```

## Roadmap

- [ ] Encrypt passowrd options

- [ ] Better compress size

- [ ] Web npm packages