Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aigoncharov/fixed-size-list
A small library that brings a fixed-length list (aka circular buffer) with an event emitter to Typescript and Javascript
https://github.com/aigoncharov/fixed-size-list
array circular-buffer fixed-length list typescript
Last synced: 2 months ago
JSON representation
A small library that brings a fixed-length list (aka circular buffer) with an event emitter to Typescript and Javascript
- Host: GitHub
- URL: https://github.com/aigoncharov/fixed-size-list
- Owner: aigoncharov
- License: mit
- Created: 2018-08-03T10:40:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:26:31.000Z (almost 3 years ago)
- Last Synced: 2024-10-12T02:53:41.450Z (3 months ago)
- Topics: array, circular-buffer, fixed-length, list, typescript
- Language: TypeScript
- Homepage:
- Size: 202 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fixed-size-list [](https://travis-ci.org/keenondrums/fixed-size-list)
Immutable fixed-length list (a.k.a circular buffer) with an event emitter for Typescript and Javascript
- [Quick start](#quick-start)
- [Initial list](#initial-list)
- [Events](#events)
- [eventNewItem](#eventnewitem)
- [eventTruncate](#eventtruncate)
- [eventReset](#eventreset)
- [eventCreated](#eventcreated)
- [API](#api)
## Quick start
```
npm i fixed-size-list
```
```ts
import { FixedSizeList } from 'fixed-size-list'
const maxSize = 3
const fixedSizeList = new FixedSizeList(maxSize)
// Now it's empty
fixedSizeList.add(1)
// Not it's [ 1 ]
fixedSizeList.add(2)
// Now it's [ 2, 1 ]
fixedSizeList.add(3)
// Now it's [ 3, 2, 1 ]
fixedSizeList.add(4)
// Now it's [ 4, 3, 2 ]
console.log(fixedSizeList.data)
// logs [4,3,2]
fixedSizeList.reset()
// Now it's []
```
## Initial list
You can set initial values easily passing them to the constructor
```ts
import { FixedSizeList } from 'fixed-size-list'
const maxSize = 3
const list = [1, 2, 3]
const fixedSizeList = new FixedSizeList(maxSize, list)
// Now it's [ 1, 2, 3 ]
```
Be aware that the initial list is truncated if it's longer than maxSize
```ts
import { FixedSizeList } from 'fixed-size-list'
const maxSize = 2
const list = [1, 2, 3]
const fixedSizeList = new FixedSizeList(maxSize, list)
// Now it's [ 1, 2 ]
// 3 was truncated
```
## Events
FixedSizeList has an event emitter. You can listen to specific events. WARNING! `on` returns an unsubscribe function. Do not forget to call it when you no longer need the subscription to unsubscribe.
### eventNewItem
It emits an added item
```ts
import { FixedSizeList, eventNewItem } from 'fixed-size-list'
const maxSize = 2
const fixedSizeList = new FixedSizeList(maxSize)
const unsubscribe = fixedSizeList.on(eventNewItem, (newItem) => console.log('item added', newItem))
fixedSizeList.add(5)
// logs 'item added 5'
// later on
unsubscribe()
```
### eventTruncate
It emits an array of removed items
```ts
import { FixedSizeList, eventTruncate } from 'fixed-size-list'
const maxSize = 2
const fixedSizeList = new FixedSizeList(maxSize)
const unsubscribe = fixedSizeList.on(eventTruncate, (removedItems) =>
console.log('items removed', removedItems.toString()),
)
fixedSizeList.add(5)
fixedSizeList.add(4)
fixedSizeList.add(3)
// logs 'items removed [ 5 ]'
// later on
unsubscribe()
```
### eventReset
```ts
import { FixedSizeList, eventReset } from 'fixed-size-list'
const maxSize = 2
const fixedSizeList = new FixedSizeList(maxSize)
const unsubscribe = fixedSizeList.on(eventReset, () => console.log('list reset'))
fixedSizeList.reset()
// logs 'list reset'
// later on
unsubscribe()
```
### eventCreated
We can add the third optional parameter of FixedSizeList's constructor and pass a custom event emitter
```ts
import { FixedSizeList, eventCreated, IFixedSizeListEvents } from 'fixed-size-list'
import mitt from 'mitt'
const maxSize = 2
const list = []
const emitter = mitt()
const unsubscribe = emitter.on(eventCreated, () => console.log('list created'))
const fixedSizeList = new FixedSizeList(maxSize, list, emitter)
// logs 'list created'
// later on
unsubscribe()
```
### All
We can subscribe to all events at once
```ts
import { FixedSizeList, eventCreated, IFixedSizeListEvents } from 'fixed-size-list'
const fixedSizeList = new FixedSizeList(10)
const unsubscribe = emitter.on('*', () => console.log('Any event'))
// later on
unsubscribe()
```