array-list's Introduction

array-list

Simple array list implementation.

Install

$ npm install array-list --save

Usage

var arrayList = require('array-list')

// with limit
var arr = arrayList(100)

// without limit
var arr = arrayList()

API

arrayList([limit])

limit

Type: integer

Specify the limit of the array. It's need to be a positive integer number.

.size()

Returns how many elements are stored in the array list.

This value is different from .length, that returns the size reserved for the array.

.push({element})

It adds a new element in the array list.

This methods could be throw an error if:

You don't provide a valid element.
The array list is full.

.get([element])

It gets the elements in the array list.

You can specify an index, in other case the methods will return all the elements.

.clear()

It removes all the elements in the array list.

.flush()

It returns a copy of the elements in array list.

An alias from concat .get + .clear.

.isEmpty()

Returns true is the .size is 0; false in other case.

.isFull()

Returns true is the .size is equal to limit; false in other case.

array-future – A collection of Array prototypes prollyfills as proposition for ECMAScript 7.

License

MIT © Kiko Beats.

array-list's People

Contributors

Stargazers

Watchers

array-list's Issues

TypeScript type declaration file

If you want I can write a TypeScript type declaration file for this package so that TS developers can utilise the type-checking feature of the language as they use this package. Let me know if you are interested.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all 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 we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

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

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.

Refactor to use of ES6 Classes

I was wondering if you are open to a Refactor on this in order to use ES6 Classes to make it a little bit more familiar with Java I'm happy to open a PR if you want, just wanted to ask first.

Thank you.

Recommend Projects

kikobeats / array-list Goto Github PK