granula-string v1.0.6
Granula String
- A lovely mini string util package.
- Functionalities may increase in the future.
Question
Why do I build this?
I found myself performing the same operation on string across various projects, thus I build this granula-string and I do not have to write duplicated codes
What are the functionalities?
- Check if a string is empty/blank/white space/alphabet/int(positive & negative)/float(positive & negative)
- Reverse string, split string into char array
- Check if a string has reach a certain number of characters
- Check if both string is equal ... and many more!
Of course the functionalities may increase in the future
How do I use it?
There are 2 ways of using this package:
Object Oriented Programming (OOP) approach
and
Functional Programming (FP) approach
,
OOP
There's a class named as GranulaString that extends String
I chose not to use Monkey Patch approach in fear of breaking others code,
Refer: https://www.audero.it/blog/2016/12/05/monkey-patching-javascript/
import { GranulaString } from 'granula-string'
const string = GranulaString.createFromString('123')
const empty = string.isEmpty()
const blank = string.isBlank()
const equal = string.isEqual('123')
const inRangeOf = string.isInRangeOf({
min: 10,
max: 100,
excludeBlankSpace: true
})
const anotherString: String = string.toParentString() // convert back to String object
FP
import { isEmpty, isBlank, inRangeOf, isEqual } from 'granula-string'
const string = '123'
const empty = isEmpty(string)
const blank = isBlank(string)
const equal = isEqual(string, '123')
const inRangeOf = isInRangeOf(string, {
min: 10,
max: 100,
excludeBlankSpace: true
})
Can I raise an issue?
Why not? Feel free to raise an issue if you have a question, an enhancement, or a bug report.
How can I contribute?
Here you are. If you have read this far, what more can I say?
I am glad that someone actually took their time to read this mini-package of mine
Here are a few things you should take note of for contribution
Use TypeScript
Write Test Code
How to use
yarn add granula-string
OR
npm i granula-string