@immutable-array/splice
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 917
- increased by91.84%
Weekly downloads
Changelog
v1.0.6
<!-- Release notes generated using configuration in .github/release.yml at v1.0.6 -->Full Changelog: https://github.com/azu/immutable-array-prototype/compare/v1.0.5...v1.0.6
Readme
@immutable-array/splice
Immutable Array.prototype.splice().
Install
Install with npm:
npm install @immutable-array/splice
Usage
Same API with Array.prototype.splice().
/**
* Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
* @param array Base array.
* @param start The zero-based location in the array from which to start removing elements.
* @param deleteCount The number of elements to remove.
* @param items Elements to insert into the array in place of the deleted elements.
*/
export declare function splice<T>(array: Array<T>, start?: number, deleteCount?: number, ...items: T[]): Array<T>;
Example
Delete all:
import { splice } from "@immutable-array/splice"
const originalArray = ["a", "b", "c", "d", "e"];
const resultArray = splice(originalArray, 0);
assert.deepStrictEqual(resultArray, []);
Delete range: 1-3
import { splice } from "@immutable-array/splice"
const originalArray = ["a", "b", "c", "d", "e"];
const resultArray = splice(originalArray, 1, 3);
assert.deepStrictEqual(resultArray, ["a", "e"]);
Delete and Insert = replace index 0 with "x"
import { splice } from "@immutable-array/splice"
const originalArray = ["a", "b", "c", "d", "e"];
const resultArray = splice(originalArray, 0, 1, "x");
assert.deepStrictEqual(resultArray, ["x", "b", "c", "d", "e"]);
Changelog
See Releases page.
Running tests
Install devDependencies and Run npm test:
npm i -d && npm test
Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Author
License
MIT © azu
FAQs
Immutable Array.prototype.splice
The npm package @immutable-array/splice receives a total of 916 weekly downloads. As such, @immutable-array/splice popularity was classified as not popular.
We found that @immutable-array/splice demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.