Immutable Array prototype methods.
- TypeScript
- Small and Thin
@immutable-array/prototypethat includes all methods: ~500bytes(gzip+minify)
- Per method packages
@immutable-array/push,@immutable-array/popetc...
- Same usage with native
Array.prototypemethods
ECMAScript Array has some mutable methods.
This library provide immutable version of each methods.
| Native method: Return type | @immutable-array/* |
|---|---|
Array.prototype.pop(): any |
pop(): new Array |
Array.prototype.push(): Number |
push(): new Array |
Array.prototype.shift(): any |
shift(): new Array |
Array.prototype.unshift(): Number |
unshift(): new Array |
Array.prototype.splice(): Array |
splice(): new Array |
Array.prototype.reverse(): Array |
reverse(): new Array |
Array.prototype.sort(): Array |
sort(): new Array |
Array.prototype.fill(): Array |
fill(): new Array |
Array.prototype.copyWithin(): Array |
copyWithin(): new Array |
@immutable-array/prototype includes all methods.
Install with npm:
npm install @immutable-array/prototype
If you want to a single method, you can use a method as a package.
Per method packages:
npm install @immutable-array/pop
npm install @immutable-array/push
npm install @immutable-array/shift
npm install @immutable-array/unshift
npm install @immutable-array/sort
npm install @immutable-array/reverse
npm install @immutable-array/fill
npm install @immutable-array/splice
npm install @immutable-array/copy-within
See each package's README for more details.
@immutable-array/prototype is a collection of immutable Array.prototype methods.
Basically, the usage of these method is same with mutable version.
import {
sort,
unshift,
push,
fill,
splice,
pop,
reverse,
copyWithin,
shift
} from '@immutable-array/prototype';
describe('prototype', () => {
it('shift', () => {
assert.deepStrictEqual(shift(['a', 'b', 'c', 'd', 'e']), [
'b',
'c',
'd',
'e'
]);
});
it('unshift', () => {
assert.deepStrictEqual(unshift(['a', 'b', 'c', 'd', 'e'], 'x'), [
'x',
'a',
'b',
'c',
'd',
'e'
]);
});
it('pop', () => {
assert.deepStrictEqual(pop(['a', 'b', 'c', 'd', 'e']), [
'a',
'b',
'c',
'd'
]);
});
it('push', () => {
assert.deepStrictEqual(push(['a', 'b', 'c', 'd', 'e'], 'x'), [
'a',
'b',
'c',
'd',
'e',
'x'
]);
});
it('splice', () => {
assert.deepStrictEqual(splice(['a', 'b', 'c', 'd', 'e'], 0, 1, 'x'), [
'x',
'b',
'c',
'd',
'e'
]);
});
it('sort', () => {
assert.deepStrictEqual(sort(['e', 'a', 'c', 'b', 'd']), [
'a',
'b',
'c',
'd',
'e'
]);
});
it('reverse', () => {
assert.deepStrictEqual(reverse(['a', 'b', 'c', 'd', 'e']), [
'e',
'd',
'c',
'b',
'a'
]);
});
it('fill', () => {
assert.deepStrictEqual(fill(new Array(5), 'x'), ['x', 'x', 'x', 'x', 'x']);
});
it('copyWithin', () => {
assert.deepStrictEqual(copyWithin(['a', 'b', 'c', 'd', 'e'], 0, 3, 4), [
'd',
'b',
'c',
'd',
'e'
]);
});
});Benchmark that is native Array.prototype methods vs. @immutable-array
See benchmark.
Native `Array.prototype` | @immutable-array
> node src/array.js | > immutable-array.js
|
# pop 200000 times >>> # pop 200000 times
ok ~330 ms (0 s + 330397151 ns) >>> ok ~267 ms (0 s + 267348617 ns)
|
# push 200000 times >>> # push 200000 times
ok ~169 ms (0 s + 168738061 ns) >>> ok ~141 ms (0 s + 140502324 ns)
|
# shift 200000 times <<< # shift 200000 times
ok ~296 ms (0 s + 295892983 ns) <<< ok ~419 ms (0 s + 418852725 ns)
|
# unshift 200000 times <<< # unshift 200000 times
ok ~51 ms (0 s + 50817590 ns) <<< ok ~191 ms (0 s + 191329502 ns)
|
# sort 2000 times >>> # sort 2000 times
ok ~933 ms (0 s + 932551400 ns) >>> ok ~611 ms (0 s + 610748601 ns)
|
# reverse 200000 times >>> # reverse 200000 times
ok ~555 ms (0 s + 554921645 ns) >>> ok ~455 ms (0 s + 455068191 ns)
|
# fill 200000 times >>> # fill 200000 times
ok ~782 ms (0 s + 782159758 ns) >>> ok ~699 ms (0 s + 698677543 ns)
|
# splice 200000 times <<< # splice 200000 times
ok ~287 ms (0 s + 286547242 ns) <<< ok ~391 ms (0 s + 391294720 ns)
|
# copyWithin 200000 times <<< # copyWithin 200000 times
ok ~237 ms (0 s + 236837575 ns) <<< ok ~275 ms (0 s + 275267401 ns)
|
all benchmarks completed >>> all benchmarks completed
ok ~3.64 s (3 s + 638863405 ns) >>> ok ~3.45 s (3 s + 449089624 ns)
- Provide immutable version of
Array.prototypemethod - Provide each method as an module
- e.g.)
import push from "@immutable-array/push" - All prototype method:
import { push } from "@immutable-array/prototype"
- e.g.)
- ECMAScript compatible API
For example, @immutable-array/* method should return same result with native API.
import { splice } from '@immutable-array/splice';
var array = [1, 2, 3];
// immutable
var resultArray = splice(array, -1, 1, 'x');
// native
array.splice(-1, 1, 'x');
assert.deepStrictEqual(array, resultArray);- Add non-standard method in ECMAScript
- e.g.)
update,delete,merge...
- e.g.)
- Each method depended on other method
- Pure javascript immutable arrays
- georapbox/immutable-arrays: Immutable versions of normally mutable array methods
- micnews/immutable-array-methods
- kolodny/immutability-helper: mutate a copy of data without changing the original source
See Releases page.
Run following commands:
yarn install
yarn test
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
MIT © azu