{"id":26468665,"url":"https://github.com/stdlib-js/dstructs-circular-buffer","last_synced_at":"2026-05-20T06:02:31.795Z","repository":{"id":282801487,"uuid":"938007011","full_name":"stdlib-js/dstructs-circular-buffer","owner":"stdlib-js","description":"Circular buffer.","archived":false,"fork":false,"pushed_at":"2025-03-17T02:22:55.000Z","size":377,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T02:42:03.837Z","etag":null,"topics":["buffer","circular","collection","cyclic","data","data-structure","data-structures","fifo","first-in-first-out","javascript","node","node-js","nodejs","queue","ring","stdlib","structure"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2025-02-24T09:19:34.000Z","updated_at":"2025-03-17T01:48:16.000Z","dependencies_parsed_at":"2025-03-17T02:42:09.836Z","dependency_job_id":"941ba3be-bfaf-4930-b556-6701af189bcf","html_url":"https://github.com/stdlib-js/dstructs-circular-buffer","commit_stats":null,"previous_names":["stdlib-js/dstructs-circular-buffer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fdstructs-circular-buffer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fdstructs-circular-buffer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fdstructs-circular-buffer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fdstructs-circular-buffer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/dstructs-circular-buffer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244460247,"owners_count":20456301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buffer","circular","collection","cyclic","data","data-structure","data-structures","fifo","first-in-first-out","javascript","node","node-js","nodejs","queue","ring","stdlib","structure"],"created_at":"2025-03-19T16:14:49.625Z","updated_at":"2026-05-20T06:02:31.789Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Circular Buffer\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Circular buffer constructor.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/dstructs-circular-buffer\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar circularBuffer = require( '@stdlib/dstructs-circular-buffer' );\n```\n\n#### circularBuffer( buffer )\n\nReturns a new circular buffer instance.\n\n```javascript\nvar buf = circularBuffer( 3 );\n// returns \u003cCircularBuffer\u003e\n```\n\nThe `buffer` argument may either be a integer which specifies the buffer size or an array-like object to use as the underlying buffer.\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\n\n// Use a typed array as the underlying buffer:\nvar buf = circularBuffer( new Float64Array( 3 ) );\n// returns \u003cCircularBuffer\u003e\n```\n\n##### circularBuffer.prototype.clear()\n\nClears a buffer.\n\n```javascript\nvar buf = circularBuffer( 3 );\n// returns \u003cCircularBuffer\u003e\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\nbuf.push( 'beep' );\n\n// Get the number of elements currently in the buffer:\nvar n = buf.count;\n// returns 3\n\n// Clear all buffer items:\nbuf.clear();\n\n// Get the number of elements in the buffer:\nn = buf.count;\n// returns 0\n```\n\n##### circularBuffer.prototype.count\n\nRead-only property which returns the number of elements currently in the buffer.\n\n```javascript\nvar buf = circularBuffer( 3 );\n// returns \u003cCircularBuffer\u003e\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\n\n// Determine how many elements are in the buffer:\nvar n = buf.count;\n// returns 2\n```\n\n##### circularBuffer.prototype.full\n\nRead-only property which returns a `boolean` indicating if a buffer is full.\n\n```javascript\nvar buf = circularBuffer( 3 );\n// returns \u003cCircularBuffer\u003e\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\n\n// Determine if the buffer is full:\nvar bool = buf.full;\n// returns false\n\n// Add another value to the buffer:\nbuf.push( 'beep' );\n\n// Determine if the buffer is full:\nbool = buf.full;\n// returns true\n```\n\n##### circularBuffer.prototype.iterator( \\[niters] )\n\nReturns an iterator for iterating over a buffer. If an environment supports `Symbol.iterator`, the returned iterator is iterable.\n\n```javascript\nvar buf = circularBuffer( 2 );\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\nbuf.push( 'beep' );\nbuf.push( 'boop' );\n\n// Create an iterator:\nvar it = buf.iterator();\n\n// Iterate over the buffer...\nvar v = it.next().value;\n// returns 'beep'\n\nv = it.next().value;\n// returns 'boop'\n\nv = it.next().value;\n// returns 'beep'\n\nv = it.next().value;\n// returns 'boop'\n\nv = it.next().value;\n// returns 'beep'\n```\n\nBy default, provided a buffer is **full**, the method returns an infinite iterator. To limit the number of iterations, provide an `niters` argument.\n\n```javascript\nvar buf = circularBuffer( 2 );\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\nbuf.push( 'beep' );\nbuf.push( 'boop' );\n\n// Create an iterator:\nvar it = buf.iterator( buf.length );\n\n// Iterate over the buffer...\nvar v = it.next().value;\n// returns 'beep'\n\nv = it.next().value;\n// returns 'boop'\n\nvar bool = it.next().done;\n// returns true\n```\n\nA returned iterator does **not** iterate over partially full circular buffers.\n\n```javascript\nvar buf = circularBuffer( 5 );\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\n\n// Create an iterator:\nvar it = buf.iterator();\n\n// Determine if the buffer is full:\nvar bool = buf.full;\n// returns false\n\n// Iterate over the buffer...\nbool = it.next().done;\n// returns true\n```\n\nIf iterating over a partially full circular buffer is necessary, use `buf.toArray()` and iterate over the returned array.\n\n##### circularBuffer.prototype.length\n\nRead-only property returning the buffer length (i.e., capacity).\n\n```javascript\nvar buf = circularBuffer( [ 0, 0, 0 ] );\n\n// Get the buffer length:\nvar len = buf.length;\n// returns 3\n```\n\n##### circularBuffer.prototype.push( value )\n\nAdds a value to the buffer.\n\n```javascript\nvar buf = circularBuffer( 3 );\n\n// Fill the buffer...\nvar v = buf.push( 'foo' );\n// returns undefined\n\nv = buf.push( 'bar' );\n// returns undefined\n\nv = buf.push( 'beep' );\n// returns undefined\n\n// Now that the buffer is full, each push will cause a value to be removed:\nv = buf.push( 'boop' );\n// returns 'foo'\n```\n\nWhen a circular buffer is empty or partially full, this method returns `undefined`. Once a circular buffer is **full**, the method returns removed values.\n\n##### circularBuffer.prototype.toArray()\n\nReturns an array of buffer values.\n\n```javascript\nvar buf = circularBuffer( 3 );\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\nbuf.push( 'beep' );\nbuf.push( 'boop' );\n\n// Get an array of buffer values:\nvar vals = buf.toArray();\n// returns [ 'bar', 'beep', 'boop' ]\n```\n\n##### circularBuffer.prototype.toJSON()\n\nSerializes a circular buffer as JSON.\n\n```javascript\nvar buf = circularBuffer( 3 );\n\n// Add values to the buffer:\nbuf.push( 'foo' );\nbuf.push( 'bar' );\nbuf.push( 'beep' );\nbuf.push( 'boop' );\n\n// Serialize to JSON:\nvar o = buf.toJSON();\n// returns { 'type': 'circular-buffer', 'length': 3, 'data': [ 'bar', 'beep', 'boop' ] }\n```\n\n**Note**: `JSON.stringify()` implicitly calls this method when stringifying a circular buffer instance.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   The constructor supports array-like object `buffer` arguments which use getter and setter accessors for element access (e.g., [`Complex64Array`][@stdlib/array/complex64], [`Complex128Array`][@stdlib/array/complex128], etc).\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar circularBuffer = require( '@stdlib/dstructs-circular-buffer' );\n\n// Create a circular buffer capable of holding 5 elements:\nvar buf = circularBuffer( 5 );\nconsole.log( 'Buffer length: %s', buf.length );\n\n// Continuously add values to the buffer...\nvar v;\nvar i;\nfor ( i = 0; i \u003c 100; i++ ) {\n    v = buf.push( i );\n    console.log( 'Count: %d. Added value: %s. Removed value: %s.', buf.count, i, ( v === void 0 ) ? '(none)' : v );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/dstructs-fifo`][@stdlib/dstructs/fifo]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003efirst-in-first-out (FIFO) queue.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/dstructs-stack`][@stdlib/dstructs/stack]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003estack.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2026. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/dstructs-circular-buffer.svg\n[npm-url]: https://npmjs.org/package/@stdlib/dstructs-circular-buffer\n\n[test-image]: https://github.com/stdlib-js/dstructs-circular-buffer/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/dstructs-circular-buffer/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/dstructs-circular-buffer/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/dstructs-circular-buffer?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/dstructs-circular-buffer.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/dstructs-circular-buffer/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg\n[chat-url]: https://stdlib.zulipchat.com\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/dstructs-circular-buffer/tree/deno\n[deno-readme]: https://github.com/stdlib-js/dstructs-circular-buffer/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/dstructs-circular-buffer/tree/umd\n[umd-readme]: https://github.com/stdlib-js/dstructs-circular-buffer/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/dstructs-circular-buffer/tree/esm\n[esm-readme]: https://github.com/stdlib-js/dstructs-circular-buffer/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/dstructs-circular-buffer/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/dstructs-circular-buffer/main/LICENSE\n\n[@stdlib/array/complex64]: https://github.com/stdlib-js/array-complex64\n\n[@stdlib/array/complex128]: https://github.com/stdlib-js/array-complex128\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/dstructs/fifo]: https://github.com/stdlib-js/dstructs-fifo\n\n[@stdlib/dstructs/stack]: https://github.com/stdlib-js/dstructs-stack\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fdstructs-circular-buffer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fdstructs-circular-buffer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fdstructs-circular-buffer/lists"}