@immutable-array/shift
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

@immutable-array/shift

Immutable Array.prototype.shift().

Install

Install with npm:

npm install @immutable-array/shift

Usage

Same API with Array.prototype.shift().

/**
 * Removes the first element from an array and returns it.
 */
export declare function shift<T>(array: Array<T>): Array<T>;

Example

import { shift } from "@immutable-array/shift"
const originalArray = ["a", "b", "c", "d", "e"];
const resultArray = shift(originalArray);
assert.deepStrictEqual(resultArray, ["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.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu

Readme

Keywords

Package Sidebar

Install

npm i @immutable-array/shift

Weekly Downloads

11

Version

1.0.6

License

MIT

Unpacked Size

4.48 kB

Total Files

7

Last publish

Collaborators

  • azu