@tfs-8/alphanum NPM

AlphaNum

AlphaNum is a lightweight JavaScript utility for encoding and decoding alphanumeric text into numeric representations. It maps letters to their positions in the alphabet and converts them back.

Features

Encodes alphabetic characters (a-z) to their numeric positions (1-26).
Decodes numeric representations back to text.
Preserves spaces between words during encoding and decoding.
Ignores non-alphabetic characters during decoding.
Case-insensitive operation.

Installation & Usage Via NPM

Install the package using npm:

npm install @tfs-8/alphanum

Usage

Import Methods

CommonJS Import

const AlphaNum = require("@tfs-8/alphanum");

ES Module Import

import AlphaNum from "@tfs-8/alphanum";

Encode & Decode

Encoding Text

The encode method converts a string into its numeric representation, where:

a becomes 1, b becomes 2, ..., z becomes 26.
Spaces are preserved, and non-alphabetic characters are ignored.

const encoded = AlphaNum.encode("hello world");
console.log(encoded); // Output: 8-5-12-12-15 23-15-18-12-4

Decoding Text

The decode method converts a numeric representation back into text.

const decoded = AlphaNum.decode("8-5-12-12-15 23-15-18-12-4");
console.log(decoded); // Output: hello world

Example

Here's a complete example of encoding and decoding:

const AlphaNum = require("@tfs-8/alphanum");

// Input message
const message = "hello world";

// Encode the message
const encodedMessage = AlphaNum.encode(message);
console.log("Encoded:", encodedMessage); // Output: 8-5-12-12-15 23-15-18-12-4

// Decode the encoded message
const decodedMessage = AlphaNum.decode(encodedMessage);
console.log("Decoded:", decodedMessage); // Output: hello world

Installation & Usage via CDN

Installation

Use the library via CDN in your HTML file:

<script src="https://unpkg.com/@tfs-8/alphanum/dist/alpha-num.umd.js"></script>

Usage

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>AlphaNum CDN Example</title>
    <!-- Import AlphNum -->
    <script src="https://unpkg.com/@tfs-8/alphanum/dist/alpha-num.umd.js"></script>
  </head>
  <body>
    <h1>AlphaNum Example</h1>
    <script>
      // Use AlphNum
      console.log(AlphaNum.encode("hello world")); // Output: 8-5-12-12-15 23-15-18-12-4
      console.log(AlphaNum.decode("8-5-12-12-15 23-15-18-12-4")); // Output: hello world
    </script>
  </body>
</html>

Notes on CDN Usage

When included via the CDN, the library is available globally as AlphaNum.
No installation or setup is required.

Notes

Non-Alphabetic Characters:
During decoding, only valid numeric positions (1-26) are converted to letters. All other characters are ignored.
Case Insensitivity:
Encoding treats both uppercase and lowercase letters as the same.

Contributing

Contributions are welcome!
If you'd like to improve this library, please follow these steps:

Fork the repository.
Make your changes.
Submit a pull request.

For any issues or feature requests, visit the issues page

Credits

Created by: Farhan Madni

License

This library is licensed under the Apache 2.0 License.

alpha numeric alphanumeric encode decode converter string number alphabet utility javascript text-utility

0.9.4

7 months ago