https://github.com/nulldev/whitespace-parse
:black_square_button: A custom single-line whitespace de- and encoder.
https://github.com/nulldev/whitespace-parse
npm npm-package nulldev parser parsing whitespace
Last synced: 10 months ago
JSON representation
:black_square_button: A custom single-line whitespace de- and encoder.
- Host: GitHub
- URL: https://github.com/nulldev/whitespace-parse
- Owner: NullDev
- License: apache-2.0
- Created: 2018-01-10T13:46:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-01-18T10:46:42.000Z (about 5 years ago)
- Last Synced: 2025-03-19T21:27:41.247Z (10 months ago)
- Topics: npm, npm-package, nulldev, parser, parsing, whitespace
- Language: JavaScript
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Whitespace-Parse
Custom single-line whitespace de- and encoder
## :information_source: About
This NodeJS package allows you to encode text to whitespace and vice versa.
**Note:** This is **CUSTOM** whitespace! There are _no_ linebreaks! Only tabs and spaces.
How?
```Assembly
a = 97 - ASCII Character code in decimal
a = 1100001 - Same value in binary
a = ' ' - In Whitespace
```
So each character has a sequence of exactly 7 binary values.
If the the encoding of a string has less characters, for example "!" which decodes to "100001" (6 characters) a padding needs to be applied at the start of the string.
In this case it would be 0 + 100001 to get to the 7 characters.
## :postbox: NPM
[](https://www.npmjs.com/package/whitespace-parse)
## :wrench: Installation
```Assembly
npm i whitespace-parse
```
## :bulb: API
- [decode()](#decode)
- [encode()](#encode)
- [toBinary()](#tobinary)
### decode()
| No. | Arguments | Description | Required | Default |
| --- | --- | --- | --- | --- |
| 1 | string | the whitespace string to decode | yes | N/A |
**Example:**
```Javascript
var whitespace = require("whitespace-parse");
console.log(whitespace.decode(" "));
// => "Hi"
```
### encode()
| No. | Arguments | Description | Required | Default |
| --- | --- | --- | --- | --- |
| 1 | string | the ASCII string to encode | yes | N/A |
**Example:**
```Javascript
var whitespace = require("whitespace-parse");
console.log(whitespace.encode("Hi"));
// => " "
```
### toBinary()
| No. | Arguments | Description | Required | Default |
| --- | --- | --- | --- | --- |
| 1 | string | The ASCII string to encode | yes | N/A |
| 2 | boolean | Should all character sequences be split by a space | no | no |
**Example:**
```Javascript
var whitespace = require("whitespace-parse");
console.log(whitespace.toBinary("hi"));
// => "11010001101001"
console.log(whitespace.toBinary("hi", true));
// => "1101000 1101001"
```
## :copyright: Copyright
`Copyright (c) NullDev`