@ververv/string-utils v1.0.0

@your-username/string-utils

A collection of TypeScript string utility functions.

Installation

npm install @your-username/string-utils

Usage

import { capitalize, truncate } from '@your-username/string-utils';

// Capitalize a string
const capitalized = capitalize('hello'); // 'Hello'

// Truncate a string
const truncated = truncate('hello world', { length: 8 }); // 'hello...'
const customTruncated = truncate('hello world', { 
  length: 8, 
  omission: '---' 
}); // 'hello---'

API

capitalize(str: string): string

Capitalizes the first letter of a string.

truncate(str: string, options: TruncateOptions): string

Truncates a string if it's longer than the specified length.

Options:

• length: Maximum length of the truncated string (including omission)
• omission: String to indicate text is omitted (default: '...')

License

MIT

// LICENSE MIT License

Copyright (c) year

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and inclusion of the Software shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.