https://github.com/stdlib-js/utils-pop
Remove and return the last element of a collection.
https://github.com/stdlib-js/utils-pop
array cut delete float32array float64array int32array javascript node node-js nodejs pop remove shorten stdlib typed-array util utilities utility utils
Last synced: 4 months ago
JSON representation
Remove and return the last element of a collection.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-pop
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:32:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T08:15:00.000Z (6 months ago)
- Last Synced: 2025-01-02T00:49:20.128Z (5 months ago)
- Topics: array, cut, delete, float32array, float64array, int32array, javascript, node, node-js, nodejs, pop, remove, shorten, stdlib, typed-array, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 847 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# pop
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Remove and return the last element of a collection.
## Installation
```bash
npm install @stdlib/utils-pop
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var pop = require( '@stdlib/utils-pop' );
```
#### pop( collection )
Removes and returns the last element of a `collection`. A `collection` may be either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (i.e., an [`Object`][mdn-object] having a valid writable `length` property).
```javascript
var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
var out = pop( arr );
// returns [ [ 1.0, 2.0, 3.0, 4.0 ], 5.0 ]
var bool = ( out[ 0 ] === arr );
// returns true
var lastValue = out[ 1 ];
// returns 5.0
```
In contrast to [`Array.prototype.pop`][mdn-array-pop] which returns only the removed element, the function also returns the shortened collection. For [typed arrays][mdn-typed-array] having a length greater than `0`, the returned collection is a new [typed array][mdn-typed-array] view.
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var arr = new Float64Array( 2 );
arr[ 0 ] = 1.0;
arr[ 1 ] = 2.0;
var out = pop( arr );
// returns [ [ 1.0 ], 2.0 ]
var bool = ( out[ 0 ] === arr );
// returns false
bool = ( out[ 0 ].buffer === arr.buffer );
// returns true
var lastValue = out[ 1 ];
// returns 2.0
```
## Notes
- When provided a [typed array][mdn-typed-array], the function does **not** change the underlying [`ArrayBuffer`][mdn-arraybuffer]. The function returns a new [typed array][mdn-typed-array] view whose length is one less than the input [typed array][mdn-typed-array] length. Accordingly, the function does **not** reduce the memory footprint of an input [typed array][mdn-typed-array].
## Examples
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var pop = require( '@stdlib/utils-pop' );
var arr;
var out;
var i;
arr = new Float64Array( 100 );
for ( i = 0; i < 100; i++ ) {
out = pop( arr );
arr = out[ 0 ];
console.log( 'Length: %d', arr.length );
}
console.log( arr );
```
* * *
## See Also
- [`@stdlib/utils-push`][@stdlib/utils/push]: add one or more elements to the end of a collection.
- [`@stdlib/utils-shift`][@stdlib/utils/shift]: remove and return the first element of a collection.
- [`@stdlib/utils-unshift`][@stdlib/utils/unshift]: add one or more elements to the beginning of a collection.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-pop.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-pop
[test-image]: https://github.com/stdlib-js/utils-pop/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-pop/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-pop/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-pop?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-pop/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-pop/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-pop/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-pop/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-pop/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-pop/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-pop/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-pop/main/LICENSE
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[mdn-array-pop]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/pop
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays
[mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
[@stdlib/utils/push]: https://github.com/stdlib-js/utils-push
[@stdlib/utils/shift]: https://github.com/stdlib-js/utils-shift
[@stdlib/utils/unshift]: https://github.com/stdlib-js/utils-unshift