circularr's Introduction

Circularr

Fixed size array

Install

npm i circularr

Usage

import Circularr from 'circularr'

// Create from
const arrFrom = Circularr.from([1, 2, 3, 4, 5])

// Create new with fixed size
const arr = new Circularr(3) // [undefined, undefined, undefined]

// fill using value
arr.fill(0)   // [0, 0, 0]

// shift in some values
arr.shift(16) // [0, 0, 16]
arr.shift(32) // [0, 16, 32]

// check contents
console.log(...arr) // undefined, 16, 32

Api

Fill

fill(value: T): this

Fills the array using value, effectively resetting it. Returns this.

const array = new Circularr(3) // [undefined, undefined, undefined]

/* mutate fill */
array.fill(0) // [0, 0, 0]

Shift

shift(value: T): T

shift method pushes the value to the end of the array, wherein the first value gets popped out and returned.

const array = new Circularr(3).fill(0)

array.shift(8)   // [0, 0, 8] => 0
array.shift(16)  // [0, 8, 16] => 0
array.shift(32)  // [8, 16, 32] => 0
array.shift(64)  // [16, 32, 64] => 8
array.length     // 3

Unshift

unshift(value: T): T

unshift does the opposite. It pushes the value to the front, popping the last value out.

const array = new Circularr(3).fill(0)

array.unshift(8)   // [8, 0, 0] => 0
array.unshift(16)  // [16, 8, 0] => 0
array.unshift(32)  // [32, 16, 8] => 0
array.unshift(64)  // [64, 32, 16] => 8
array.length       // 3

Slice

slice(beginIndex?: number, endIndex?: number): Circularr<T>

slice does works the same way as Array.slice().

const array = Circularr.from([1, 2, 3, 4])

const sliced = array.slice(1, 3) // [2, 3]

Trim

trim(): Circularr<T>

trim returns new Circularr with removed undefined values from both ends.

const array = new Circularr<number>(5)

array.shift(1)
array.shift(2)

const trimmed = array.trim() // [1, 2]

At

at(index: number): T | undefined

at returns element at the index. For negative indices - undefined is returned. For overflow indices - undefined is returned

const array = new Circularr<number>(5)

array.shift(1)
array.shift(2)

const val0 = array.at(0) // undefined
const val1 = array.at(3) // 1
const val2 = array.at(4) // 2
const val3 = array.at(5) // undefined

WrapAt

wrapAt(index: number): T | undefined

wrapAt returns element at the index. For negative and overflow indices - the index will be wrapped around, and correct value will be returned

const array = new Circularr<number>(5)

array.shift(1)
array.shift(2)

const val0 = array.at(0) // undefined
const val1 = array.at(3) // 1
const val2 = array.at(4) // 2
const val3 = array.at(8) // 1
const val3 = array.at(9) // 2

Iterable

Circularr implements iterable protocol, so it can be used with any standard iterable syntax

const array = Circularr.from([1, 2, 3])

// array destructuring
const [firstValue] = array

// destructuring copy
const copyToArray = [...array]

// for..of syntax
for (let value of array) {
  console.log(value)
}

circularr's People

Contributors

Stargazers

Watchers

circularr's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Recommend Projects

psxcode / circularr Goto Github PK