README.md

helpers-ts

Some simple Helpers to manipulate strings and arrays for JavaScript and Typescript.

If you like this package you can Buy me a Coffee ☕️

Table of contents

• Installation
• Usage
  • Strings
  • Arrays
• Changelog
• Contributing
• Credits
• License

Installation

# To install this package, run:
$ npm install helpers-ts
# or
$ npm i helpers-ts

Usage

This package is intended to help you manipulate strings and arrays, in JavaScript and Typescript. It is available from the NPM Registry.

import { toCamel } from 'helpers-ts'

const str = 'Hello world'
console.log(toCamel(str))

// Output: 'helloWorld'

Strings

slugify()

Converts a string into slug.

slugify('Hello world') // 'hello_world'
slugify('Hello world', '-') // 'hello-world'

toCamel()

Converts a string into camelCase.

toCamel('Hello world') // 'helloWorld'

toPascal()

Converts a string into PascalCase.

slugify('Hello world') // 'HelloWorld'

isUuid()

Checks if a string is a valid uuid.

isUuid('5c5a300f-20fb-416f-b026-6f53f8bdc7f5') // true
isUuid('not-uuid') // false

uuid()

Returns a random and unique Uuid.

uuid() // '5c5a300f-20fb-416f-b026-6f53f8bdc7f5'

limitStr()

Limits a string to a specified number of characters.

limitStr('This is a long string that needs to be limited.', 20)
// 'This is a long strin...'

randomStr()

Returns a random string with a specified number of characters.

randomStr(6) // 'ab12c3'

replaceStr()

Replaces occurrences of a string by another.

replaceStr('world', 'earth', 'Hello world') // 'Hello earth'

squish()

Trims and removes extra spaces between words with a specified number of space.

squish(' Hello     world ', 5) // 'Hello world'

Arrays

crossJoin()

Joins arrays and returns all possible combinations of input arrays.

You can pass more than 2 arrays.

crossJoin(['red', 'green'], ['small', 'medium'])
// [['red', 'small'], ['red','medium'], ['green', 'small'], ['green','medium']]

keyExists()

Checks if a key exists in an array.

keyExists('foo', ['foo', 'bar', 'baz']) // true
keyExists('qux', ['foo', 'bar', 'baz']) // false

keyExists('foo', { foo: 'bar', baz: 'qux' }) // true

firstKey(), lastKey()

Returns first or last key.

firstKey(['foo', 'bar', 'baz']) // 'foo'
lastKey(['foo', 'bar', 'baz']) // 'baz'

implode()

Converts an array into string.

implode(['Foo', 'Bar']) // 'Foo Bar'
implode(['Foo', 'Bar'], ', ') // 'Foo, Bar'

explode()

Converts a string into array.

explode('Foo,Bar') // ['Foo', 'Bar']
implode('Foo Bar', ' ') // ['Foo', 'Bar']

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

If you are interested in this project and want to improve it, fix errors or bugs, you're welcome to contribute.

Credits

• Jordan Nataf
• All Contributors

Licence

The MIT License (MIT).

Please see License File for more information.