https://github.com/igorskyflyer/npm-normalized-string
💊 NormalizedString provides you with a String type with consistent line-endings, guaranteed. 📮
https://github.com/igorskyflyer/npm-normalized-string
back-end carriage-return crlf endings igorskyflyer javascript js lf line-endings line-feed node normalized normalized-string skyflyer string typescript utility
Last synced: about 1 month ago
JSON representation
💊 NormalizedString provides you with a String type with consistent line-endings, guaranteed. 📮
- Host: GitHub
- URL: https://github.com/igorskyflyer/npm-normalized-string
- Owner: igorskyflyer
- License: mit
- Created: 2023-05-30T22:54:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-02T15:36:48.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T15:06:26.838Z (about 1 month ago)
- Topics: back-end, carriage-return, crlf, endings, igorskyflyer, javascript, js, lf, line-endings, line-feed, node, normalized, normalized-string, skyflyer, string, typescript, utility
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@igor.dvlpr/normalized-string
- Size: 52.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# normalized-string
💊 NormalizedString provides you with a String type with consistent line-endings, guaranteed. 📮
💖 Support further development
## 🕵🏼♂️ Usage
Install it by executing:
```shell
npm i "@igor.dvlpr/normalized-string"
```
## 🤹🏼♂️ API
```ts
constructor(value: string, endings: LineEndings = LineEnding.lf)
```
`value` - A string to work with.
`endings` - The line endings to use:
- `LineEnding.lf` - UNIX-like line endings (line feed),
- `LineEnding.crlf` - Windows line endings (carriage return + line feed).
You can also set the property `value` directly and the line endings will be correct.
```ts
import { NormalizedString, LineEnding } from '@igor.dvlpr/normalized-string'
const loremIpsum: string =
'Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n\r\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.\n\nDuis in nulla ut leo lobortis venenatis.'
const lfEndings: NormalizedString = new NormalizedString(loremIpsum)
lfEndings.value = 'Hello\r\nworld!'
console.log(JSON.stringify(lfEndings.value)) // returns 'Hello\nworld'
```
## 🤔 Examples
```ts
import { NormalizedString, LineEnding } from '@igor.dvlpr/normalized-string'
const loremIpsum: string =
'Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n\r\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.\n\nDuis in nulla ut leo lobortis venenatis.'
const lfEndings: NormalizedString = new NormalizedString(loremIpsum) // LF are the default endings
const crlfEndings: NormalizedString = new NormalizedString(loremIpsum, LineEnding.crlf)
console.log(JSON.stringify(lfEndings.value)) // returns 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.\n\nDuis in nulla ut leo lobortis venenatis.'
console.log(JSON.stringify(crlfEndings.value)) // returns 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n\r\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.\r\n\r\nDuis in nulla ut leo lobortis venenatis.'
```