ExtendableString

• Features
• Usage
• API
  • constructor()
  • value
  • toString()
• Examples
• Changelog
• Support
• License
• Related
• Author

• 🚀 Instantly applies custom string transformations on creation
• 🔄 Updates value with transformation applied automatically
• 🛡️ Validates transformation function before use
• 🧩 Designed for easy extension via sub-classing
• 📦 Encapsulates logic with private fields for safety
• 📝 Provides clean string output through the toString() method
• ⚡ Ensures consistent transformed state at all times

Install it by executing any of the following, depending on your preferred package manager:

pnpm add @igorskyflyer/extendable-string

yarn add @igorskyflyer/extendable-string

npm i @igorskyflyer/extendable-string

💡 TIP

First Steps

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

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.

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

Gets the transformed string value.

Returns the transformed string.

UpperCaseString.ts

import { ExtendableString } from '@igorskyflyer/extendable-string'

export class UpperCaseString extends ExtendableString {
  constructor(value: string) {
    super(value, (str) => str.toUpperCase())
  }
}

example.ts

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

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'

📑 The changelog is available here, CHANGELOG.md.

Licensed under the MIT license which is available here, MIT license.

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/keppo

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

@igorskyflyer/astro-escaped-component

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

@igorskyflyer/normalized-string

💊 NormalizedString provides you with a String type with consistent line-endings, guaranteed. 📮

@igorskyflyer/windev

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

@igorskyflyer/mapped-replacer

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

Created by Igor Dimitrijević (@igorskyflyer).