nanobuffer

2019-09-12

Lightweight, fixed-size, cyclic value buffer

NanoBuffer

NPM VersionNPM DownloadsTravis CI BuildAppveyor CI BuildTest CoverageGreenkeeper badgeDepsDev Deps

A lightweight, fixed-size value buffer.

Essentially it's an array that will only store up to N-number of values. Any additional values added overwrite the oldest values. You can iterate over the buffer to pull all of the values back out.

Installation

npm install nanobuffer

Example

import NanoBuffer from 'nanobuffer';

const buffer = new NanoBuffer(20);

for (let i = 0; i < 5; i++) {
    buffer.push(`Value ${i}`);
}

console.log(buffer.size); // 5

for (let i = 5; i < 100; i++) {
    buffer.push(`Value ${i}`);
}

console.log(buffer.size); // 20

for (const value of buffer) {
    console.log(value); // Value XX
}

API

Constructor

new NanoBuffer(maxSize=10)

Creates a new NanoBufferinstance with the specified max size. Default max size is 10.

Properties

maxSizeNumber

Gets or sets a maximum number of values that can be stored in the buffer. If you shrink the size, only the last N values will be preserved.

The value must be an integer and greater than or equal to zero. A value of zero will not buffer anything.

const buffer = new NanoBuffer;

console.log(buffer.maxSize); // 10

buffer.maxSize = 20;

console.log(buffer.maxSize); // 20

sizeNumber

Gets the number of values in the buffer. This will never exceed the maxSize.

const buffer = new NanoBuffer;

console.log(buffer.size); // 0

buffer.push('hi');
buffer.push('there');

console.log(buffer.size); // 2

Methods

push(value)

Adds a value to the buffer. If the buffer is full, then the oldest value is overwritten with this new value.

Values being stored can be any data type.

Returns the NanoBufferinstance.

const buffer = new NanoBuffer;
buffer
    .push('hello')
    .push(123)
    .push({ foo: 'bar' });

clear()

Removes all values in the buffer.

Returns the NanoBufferinstance.

const buffer = new NanoBuffer;

buffer.push('hi');
console.log(buffer.size); // 1

buffer.clear();
console.log(buffer.size); // 0

[Symbol.iterator]()

Returns an iterator that can be used in a for-of loop.

const buffer = new NanoBuffer;

buffer.push('hi');
buffer.push('there');

for (const value of buffer) {
    console.log(value);
}

const it = buffer[Symbol.iterator]();
let r = it.next();
while (!r.done) {
    console.log(r.value);
    r = it.next();
}

License

MIT

HomePage

https://github.com/cb1kenobi/nanobuffer

Repository

https://github.com/cb1kenobi/nanobuffer


上一篇:bryt
下一篇:如何给img标签里的请求的添加自定义header
相关教程
关注微信

扫码加入 JavaScript 社区

相关文章
暂无相关文章

首次访问,需要验证
微信扫码,关注即可
(仅需验证一次)

欢迎加入 JavaScript 社区

号内回复关键字:

回到顶部