https://github.com/gypsydangerous/base65536-helper

https://github.com/gypsydangerous/base65536-helper

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/gypsydangerous/base65536-helper
• Owner: GypsyDangerous
• License: mit
• Created: 2020-09-05T03:16:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-05T12:25:50.000Z (over 4 years ago)
• Last Synced: 2024-12-10T19:55:33.959Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 73.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Welcome to base65536-helper 👋



  

  

    

  



> Helper functions for the base65536 library to make it easier to encode and decode common data types. Check out base65536 at https://github.com/qntm/base65536

## Install

```sh

npm i base65636-helper

```

## Usage

```js

const {encode, decode} = require("base65536-helper")

const data = {name: "david", username: "gypsydangerous"}

const encodedData = encode(data)

const decodedData = JSON.parse(decode(encodedData)) // => {name: "david", username: "gypsydangerous"}

```

## Run tests

```sh

npm test

```

## Author

* Website: https://github.com/GypsyDangerous

* Github: [@gypsydangerous](https://github.com/gypsydangerous)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/GypsyDangerous/base65536-helper/issues). 

## Show your support

Give a ⭐️ if this project helped you!

## Documentation

 ### encode

 ```sh

 accepts "string", "number", "object", and "boolean"

 returns "base65536 string"

 ```

 ### decode

 ```sh

 accepts "base65536 string"

 returns "string"

 ```

 ### rawDecode

 #### raw base65536 decode function

 ```sh

 accepts "base65536 string"

 returns Uint8Array

 ```

  ### rawEncode

 #### raw base65536 encode function

 ```sh

 accepts Uint8Array

 returns "base65536 string"

 ```

***

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_