alphanumerics v0.9.8

Alphanumerics

alphanumerics is a simple JavaScript library that provides two core functions: encode and decode. The encode function converts plain text into a numeric representation, while the decode function transforms the encoded text back into the original string.

Features

• encode: Converts each letter of a word into its corresponding alphabetic position (e.g., a becomes 1, b becomes 2, etc.).
• decode: Converts a numeric alphabetic position back into the corresponding character.
• Customizable delimiter for separating numbers.
• Support for marking capitalized letters.
• Flexible uppercase/lowercase handling.
• Handles spaces between words and returns text in a readable format.

Installation

You can install the package via npm:

npm install alphanumerics

Usage

Basic Encoding and Decoding

import { encode, decode } from 'alphanumerics'

// Basic usage with default settings
const encodedText = encode({ text: 'Hello World', delimiter: '-', capitalizer: '*' })
console.log(encodedText)
// Output: "*8-5-12-12-15 23-15-18-12-4"

const decodedText = decode({ encodedText: '*8-5-12-12-15 23-15-18-12-4', delimiter: '-', capitalizer: '*' })
console.log(decodedText)
// Output: "Hello World"

// Using different delimiter and capitalizer
const customEncoded = encode({ text: 'Hello World', delimiter: '/', capitalizer: '#' })
console.log(customEncoded)
// Output: "#8/5/12/12/15 23/15/18/12/4"

// Using uppercase mode
const uppercaseEncoded = encode({ text: 'Hello World', delimiter: '-', capitalizer: '*', uppercase: true })
console.log(uppercaseEncoded)
// Output: "8-5-12-12-15 *23-15-18-12-4"

API

encode({ text: string, delimiter?: string, capitalizer?: string, uppercase?: boolean }): string

• Description: Converts a string into its alphabetic numeric representation.
• Parameters:
  • text (string): The plain text to be encoded.
  • delimiter (string): The character used to separate numbers in the encoded output.
  • capitalizer (string): The character used to mark capitalized letters.
  • uppercase (boolean, optional): When true, reverses the capitalization marking behavior. Defaults to false.
• Returns: A string of numeric values separated by the specified delimiter, where each value represents the position of a letter in the alphabet.
• Error handling: Returns an error message if text or delimiter is not provided.

decode({ encodedText: string, delimiter?: string, capitalizer?: string, uppercase?: boolean }): string

• Description: Converts an encoded numeric string back into the original text.
• Parameters:
  • encodedText (string): The encoded numeric string to decode.
  • delimiter (string): The character that separates numbers in the encoded input.
  • capitalizer (string): The character that marks capitalized letters.
  • uppercase (boolean, optional): When true, reverses the capitalization behavior. Defaults to false.
• Returns: The original text with proper capitalization.
• Error handling: Returns an error message if encodedText or delimiter is not provided.

Contributing

We welcome contributions! Please check the CONTRIBUTING.md for guidelines.

Credits

Created with ❤️ by @MFM-347.

License

The code in this repository is licensed under the MIT License.