Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 4.89 KB

README-EN.md

File metadata and controls

109 lines (76 loc) · 4.89 KB

Table of Contents

  1. Introduction
  2. Features
  3. Installation
  4. Usage
  5. Contribution
  6. License
  7. Acknowledge
  8. Donate
  9. Changelog

Introduction

Parse Buffer is a JavaScript function that converts the string representation of a Buffer object into the original Buffer object. This function is useful when you want to reprocess binary data stored or sent in string format.

Features

Parse Buffer offers the following features:

  • Converts a Buffer representation string into a native Buffer object.
  • Checks if the input is in a valid Buffer format.
  • Can be integrated into TypeScript code.

Installation

To install Parse Buffer locally, follow these installation steps:

npm install @barudakrosul/parse-buffer

Usage

To start using Parse Buffer, import the module first:

1. CommonJS

const parseBuffer = require("@barudakrosul/parse-buffer");

2. ESM (ECMAScript Modules)

import parseBuffer from "@barudakrosul/parse-buffer";

3. TypeScript

import parseBuffer from "@barudakrosul/parse-buffer";

Example of usage:

const bufferString = "<Buffer 48 65 6c 6c 6f 20 57 6f 72 6c 64 21>";
const buffer = parseBuffer(bufferString);

console.log(buffer); // <Buffer 48 65 6c 6c 6f 20 57 6f 72 6c 64 21>
console.log(buffer.toString()); // "Hello World!"

Contribution

Contributions to Parse Buffer are greatly appreciated! Whether reporting bugs, suggesting new features, or contributing to code improvements.

License

Parse Buffer is licensed under the MIT License - see the LICENSE file for details.

Acknowledge

Parse Buffer appreciates the support and contributions of the following individuals and open source projects:

  • @Achixz - Lead developer and creator of the application.
  • Open source community - For valuable contributions to the tools and libraries used in this project.

Donate

We really appreciate your support to continue developing this project. If you find this project useful, you can support us with a donation:

Ko-fi Trakteer

Every donation, no matter the amount, means a lot to us. Thank you for your support! ❤️

Changelog

Keep up with the latest changes and updates of Parse Buffer by referring to Changelog.

Thank you for choosing Parse Buffer! We aim to provide an easy solution to convert Buffer strings into native Buffer objects.

Stand with Palestine