# next-core-structures

> The Augmented.js Next - Structures.

Latest version **2.6.1** (published 2022-02-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install next-core-structures
pnpm add next-core-structures
yarn add next-core-structures
bun add next-core-structures
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.6.1 |
| Published | 2022-02-28 |
| First published | 2018-08-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 961.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Bob Warren |
| Maintainers | thedocbwarren |
| Keywords | augmentedjs, presentation |

## Links

- npm: https://www.npmjs.com/package/next-core-structures
- Repository: https://github.com/Augmentedjs/next-core-structures
- Homepage: http://www.augmentedjs.com
- Issues: https://github.com/Augmentedjs/next-core-structures/issues
- npm.io page: https://npm.io/package/next-core-structures

## Dependencies (1)

- [next-core-utilities](https://npm.io/package/next-core-utilities.md) ^3.4.1

## Recent versions

- 2.6.1 (latest) — 2022-02-28
- 2.6.0 — 2019-10-04
- 2.5.3 — 2018-08-20

## README

# next-core-structures

Augmented.js Next Core - Structures

# API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

*   [Stack](#stack)
    *   [Parameters](#parameters)
    *   [empty](#empty)
    *   [peek](#peek)
    *   [pop](#pop)
    *   [push](#push)
        *   [Parameters](#parameters-1)
    *   [search](#search)
        *   [Parameters](#parameters-2)
    *   [size](#size)
    *   [clear](#clear)
    *   [toArray](#toarray)
    *   [toString](#tostring)
*   [AugmentedMap](#augmentedmap)
    *   [Parameters](#parameters-3)
    *   [set](#set)
        *   [Parameters](#parameters-4)
    *   [get](#get)
        *   [Parameters](#parameters-5)
    *   [indexOf](#indexof)
        *   [Parameters](#parameters-6)
    *   [remove](#remove)
        *   [Parameters](#parameters-7)
    *   [has](#has)
        *   [Parameters](#parameters-8)
    *   [forEach](#foreach)
        *   [Parameters](#parameters-9)
    *   [key](#key)
        *   [Parameters](#parameters-10)
    *   [entries](#entries)
    *   [values](#values)
    *   [clear](#clear-1)
    *   [size](#size-1)
    *   [toJSON](#tojson)
    *   [toString](#tostring-1)
    *   [isEmpty](#isempty)
    *   [marshall](#marshall)
        *   [Parameters](#parameters-11)
*   [AsynchronousQueue](#asynchronousqueue)
    *   [Parameters](#parameters-12)
    *   [add](#add)
        *   [Parameters](#parameters-13)
    *   [clear](#clear-2)
    *   [process](#process)
        *   [Parameters](#parameters-14)
    *   [timeout](#timeout)
    *   [queue](#queue)

## Stack

Stack - Standard Stack data structure</br>

<p>Supported options are:</p>
<ul>
<li><em>stack</em> - an array to populate</li>
</ul>

### Parameters

*   `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options to pass

### empty

The empty method clears the stack

### peek

The peek method returns the first in the stack

Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns the first object in the stack

### pop

The pop method returns and removes the first in the stack

Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Returns the first object in the stack

### push

The push method adds to the stack

#### Parameters

*   `item` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The item to push to the stack

### search

The search method returns where in the stack an item exists

#### Parameters

*   `item`  

Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Returns the index of the item

### size

The size method returns the size of the stack

Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Returns the size of the stack

### clear

The clear method clears the stack

### toArray

The toArray method returns the stack as an array

Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** Returns the stack as an array

### toString

The toString method returns the stack as an string

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Returns the stack as an string

## AugmentedMap

ES6-like Map - than can marshall

### Parameters

*   `myData`  {object} Map data to fill map

### set

Set the value by key in the map

#### Parameters

*   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the key
*   `value` **any** value for the key

### get

Get the value by key in the map

#### Parameters

*   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the key

Returns **any** The value for the key

### indexOf

Index of the key in the map

#### Parameters

*   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the key

Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** index of the key

### remove

Remove the value by key in the map

#### Parameters

*   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the key

### has

Has returns whether a key exists in the map

#### Parameters

*   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the key

Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if the key exists in the map

### forEach

Iterator forEach key to value in the map

#### Parameters

*   `fn` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** callback for the iterator

### key

Get the key for the index in the map

#### Parameters

*   `i` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** index of the key

Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** the key at index

### entries

The entries value object in the map

Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array of entries value objects

### values

The values in the map as an Array

Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** values as an Array

### clear

Clear the map

### size

The size of the map in keys

Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** size of map by keys

### toJSON

Represent the map in JSON

Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** JSON of the map

### toString

Represent the map in a String of JSON

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Stringified JSON of the map

### isEmpty

Checks of the map is empty (not ES6)

Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if the map is empty

### marshall

Marshalls a map<br/>
dataToMarshall must be the following type of data to parse:
JSON object with properties (key/value)

#### Parameters

*   `dataToMarshall` **Augmented.Utility.Map** Data to marshall as a map

Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Returns true on success

## AsynchronousQueue

AsynchronousQueue -
An Async queue for handling async chained functions

### Parameters

*   `timeout` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** The timout period for each process in the queue (optional)

### add

Add method for adding processes to the queue

#### Parameters

*   `args` **...any** 

### clear

Clear all processes in the queue

### process

Process the queue

#### Parameters

*   `args` **...any** 

### timeout

Get the timeout for the queue

### queue

Get the full queue

---
_Source: https://npm.io/package/next-core-structures · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
