@arrows/string

@arrows/string

Table of contents

• Introduction
• Installation
• API reference
• License

Introduction

The purpose of the library is to provide functional wrappers for String.prototype methods and provide some additional functions for common tasks.

All wrappers try to mimic original methods as close as possible while providing composable, auto-curried versions of the string methods.

For convenience, some functions have additional methods to execute the most common use cases of the function.

Functions that do not have a native equivalent contain _ suffix. That way we can implement native-like version in the future (if an equivalent method will be added to the language), without potentially breaking backward-compatibility of the library.

The library has built-in type definitions, which provide an excellent IDE support.

Installation

Via NPM:

npm i @arrows/string

Via Yarn:

yarn add @arrows/string

All modules can be imported independently (to reduce bundle size), here are some import methods (you can use either CommonJS or ES modules):

import arr from '@arrows/string'

import { charAt } from '@arrows/string'

import charAt from '@arrows/string/charAt'

API reference

Index

• charAt

charAt

Functional wrapper for String.prototype.charAt

Retrieves the character at the specified index.

Parameters

• index Specific index
• str Initial string

Returns: Character or empty string if out of bound.

License

Project is under open, non-restrictive ISC license.