https://github.com/igorskyflyer/npm-extendable-string

🦀 ExtendableString allows you to create strings on steroids that have custom transformations applied to them, unlike common, plain strings. 🪀
https://github.com/igorskyflyer/npm-extendable-string

back-end browser class extend extendable igorskyflyer javascript js node npm string text transform ts typescript utility vitest

Last synced: 2 days ago
JSON representation

🦀 ExtendableString allows you to create strings on steroids that have custom transformations applied to them, unlike common, plain strings. 🪀

• Host: GitHub
• URL: https://github.com/igorskyflyer/npm-extendable-string
• Owner: igorskyflyer
• License: mit
• Created: 2023-05-29T15:20:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-29T20:43:59.000Z (3 months ago)
• Last Synced: 2024-09-30T06:29:22.993Z (about 1 month ago)
• Topics: back-end, browser, class, extend, extendable, igorskyflyer, javascript, js, node, npm, string, text, transform, ts, typescript, utility, vitest
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@igor.dvlpr/extendable-string
• Size: 120 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

        
ExtendableString







  🦀 ExtendableString allows you to create strings on steroids that have custom

  


  transformations applied to them, unlike common, plain strings. 🪀











  


    


    
💖 Support further development

    I work hard for every project, including this one

    


    and your support means a lot to me!

    


    


    Consider buying me a coffee. ☕

    


    Thank you for supporting my efforts! 🙏😊

    


    


    

    


    


    @igorskyflyer

    


    


    


  









## 📃 Table of contents

- [Usage](#-usage)

- [API](#-api)

  - [constructor()](#constructorraw-transformfn)

  - [value](#value-string)

  - [toString()](#tostring-string)

- [Examples](#-examples)

- [Changelog](#-changelog)

- [License](#-license)

- [Related](#-related)

- [Author](#-author)







## 🕵🏼 Usage

Install it by executing:

```shell

npm i '@igor.dvlpr/extendable-string'

```




## 🤹🏼 API




> [!WARNING]

> Do **NOT** instantiate a new object from the `ExtendableString` class, extend it instead.

>




### `constructor(raw, transformFn)`

*Creates an ExtendableString instance.*  




`raw` - The string input to transform.  

`transformFn` - The transformation function to apply to the string.  

Will throw an error if the transformation function is not supplied.

---

### `value: string`

*Gets the transformed string or sets a new value that will be transformed automatically.*

---

### `toString(): string`

*Gets the transformed string value.*  

Returns the transformed string.

---

## ✨ Examples

`UpperCaseString.mts`

```ts

import { ExtendableString } from '@igor.dvlpr/extendable-string'

export class UpperCaseString extends ExtendableString {

  constructor(value: string) {

    super(value, (str) => str.toUpperCase())

  }

}

```




`example.mts`

```ts

import { UpperCaseString } from './UpperCaseString.mjs'

const test = new UpperCaseString('aaaa')

console.log(test.value) // Outputs 'AAAA'

const example = new UpperCaseString('aaaa')

example.value = 'hello'

console.log(test.value) // Outputs 'HELLO'

```

---

## 📝 Changelog

📑 The changelog is available here: [CHANGELOG.md](https://github.com/igorskyflyer/npm-extendable-string/blob/main/CHANGELOG.md).

---

## 🪪 License

Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-extendable-string/blob/main/LICENSE).

---

## 🧬 Related

[@igor.dvlpr/keppo](https://www.npmjs.com/package/@igor.dvlpr/keppo)

> _🎡 Parse, manage, compare and output SemVer-compatible version numbers. 🛡_




[@igor.dvlpr/astro-escaped-component](https://www.npmjs.com/package/@igor.dvlpr/astro-escaped-component)

> _🏃🏻‍♂️‍➡️ An Astro component that holds only HTML-encoded content. 📜_




[@aria-toolkit/shared](https://www.npmjs.com/package/@aria-toolkit/shared)

> _👻 Shared resources between Aria modules. 🐦‍⬛_




[@igor.dvlpr/windev](https://www.npmjs.com/package/@igor.dvlpr/windev)

> _🍃 Provides ways of checking whether a path is a legacy Windows device. 💾_




[@igor.dvlpr/mapped-replacer](https://www.npmjs.com/package/@igor.dvlpr/mapped-replacer)

> _🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁_

---




### 👨🏻‍💻 Author

Created by **Igor Dimitrijević** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).