[Feature Request]: Add the ability to use lower case letters in the dictionary

[M-Scott-Lassiter]

Contact Details

No response

Description

Right now, the dictionary doesn't allow lower case letters.

const AlphanumericEncoder = require('alphanumeric-encoder')

const encoder = new AlphanumericEncoder()

encoder.dictionary = 'abcd'
console.log(encoder.dictionary) // 'ABCD'

console.log(encoder.decode('D')) // 4
console.log(encoder.decode('d')) // undefined

I would like the ability to specify that lower case letters are in fact allowed. This is going to involve adding a new property: allowLowerCaseDictionary. The property should be

• a getter/setter combo
• false by default (avoids breaking compatibility and checks with most standard use cases)
• referenced in the dictionary setter
• documented with JSDoc
• have associated tests to keep coverage at 100%

The decode script as it is now should work appropriately.

The final expected behavior is this

const AlphanumericEncoder = require('alphanumeric-encoder')

const encoder = new AlphanumericEncoder()

encoder.allowLowerCaseDictionary = true
encoder.dictionary = 'ABCDabcd'
console.log(encoder.dictionary) // 'ABCDabcd'

console.log(encoder.encode(6)) // 'b'
console.log(encoder.encode(15)) // 'Ac'
console.log(encoder.decode('D')) // 4
console.log(encoder.decode('AA')) // 9

Are you able/willing to make the change? (It's ok if you're not!)

Yes

Code of Conduct

• I agree to follow this project's Code of Conduct

[M-Scott-Lassiter]

🎉 This issue has been resolved in version 1.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀