insert-string

Inserts a string inside another string.

Node Repository

https://www.npmjs.com/package/@pelevesque/insert-string

Installation

npm install @pelevesque/insert-string

Tests

Command | Description ---------------------------- | ------------ npm test or npm run test | All Tests Below npm run cover | Standard Style npm run standard | Coverage npm run unit | Unit Tests

Usage

Requiring the Module

const insertString = require('@pelevesque/insert-string')

Insertion

const str = 'I have an apple.'
const insert = 'an orange and '
const index = 7
const result = insertString(str, insert, index)
// result === 'I have an orange and an apple.'

Substitution

The fourth parameter numCharsToRemove defaults to 0 which permits inserts.

To make a substitution, setting numCharsToRemove to -1 will give it the same length as the string to insert.

const str = 'A nice guy.'
const insert = 'cool'
const index = 2
const numCharsToRemove = -1
const result = insertString(str, insert, index, numCharsToRemove)
// result === 'A cool guy.'

Irregular Substitution

By explicitly setting numCharsToRemove to the number of characters to remove, it's possible to do substitutions where the string to insert does not have the same length as the string that it is replacing.

const str = 'My name is Jack Black and I act.'
const insert = 'Joe'
const index = 11
const numCharsToRemove = 10 // the length of 'Jack Black'
const result = insertString(str, insert, index, numCharsToRemove)
// result === 'My name is Joe and I act.'

A Substitution Using a Negative Index

You can use a negative index to add the insert before the original string.

const str = 'abc'
const substitution = '012'
const index = -3
const result = insertString(str, insert, index)
// result === '012abc'