# array-dsl

> A Dsl approach toward arrays.

Latest version **1.6.59** (published 2019-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install array-dsl
pnpm add array-dsl
yarn add array-dsl
bun add array-dsl
```

## 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 | 1.6.59 |
| Published | 2019-05-21 |
| First published | 2018-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Imre Toth |
| Maintainers | 311ecode |
| Keywords | curry, array, dsl-framework, dsl, tooling |

## Links

- npm: https://www.npmjs.com/package/array-dsl
- Repository: https://github.com/vidaxl-com/cowlog
- Homepage: https://github.com/vidaxl-com/cowlog/tree/master/packages/dsl-framework/examples/array-dsl
- Issues: https://github.com/vidaxl-com/cowlog/issues
- npm.io page: https://npm.io/package/array-dsl

## Dependencies (12)

- [arrify](https://npm.io/package/arrify.md) ^2.0.1
- [arr-xor](https://npm.io/package/arr-xor.md) ^1.0.1
- [isarray](https://npm.io/package/isarray.md) ^2.0.4
- [arr-diff](https://npm.io/package/arr-diff.md) ^4.0.0
- [d3-array](https://npm.io/package/d3-array.md) ^2.1.0
- [array-uniq](https://npm.io/package/array-uniq.md) ^2.1.0
- [array-union](https://npm.io/package/array-union.md) ^2.1.0
- [random-item](https://npm.io/package/random-item.md) ^3.0.0
- [array-flatten](https://npm.io/package/array-flatten.md) ^2.1.2
- [dsl-framework](https://npm.io/package/dsl-framework.md) ^1.6.55
- [array-find-index](https://npm.io/package/array-find-index.md) ^1.0.2
- [unique-random-array](https://npm.io/package/unique-random-array.md) ^2.0.0

## Recent versions

- 1.6.59 (latest) — 2019-05-21
- 1.6.53 — 2019-05-18
- 1.6.52 — 2019-05-17
- 1.6.51 — 2019-05-17
- 1.6.50 — 2019-05-16
- 1.6.42 — 2019-05-13
- 1.6.41 — 2019-05-12
- 1.6.40 — 2019-05-09
- 1.6.39 — 2019-05-08
- 1.6.38 — 2019-05-08
- 1.6.37 — 2019-05-05
- 1.6.36 — 2019-04-26
- 1.6.35 — 2019-04-25
- 1.6.34 — 2019-04-24
- 1.6.33 — 2019-04-21
- … 16 more at https://npm.io/package/array-dsl/versions

## README

An array focused DSL
<!--- destination qa rewrite begin -->
### QA monorepo
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![CircleCI](https://circleci.com/gh/vidaxl-com/cowlog/tree/master.svg?style=svg)](https://circleci.com/gh/vidaxl-com/cowlog/tree/master)
[![Test Coverage](https://api.codeclimate.com/v1/badges/d3fce811aecbe5c73ffb/test_coverage)](https://codeclimate.com/github/vidaxl-com/cowlog/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/d3fce811aecbe5c73ffb/maintainability)](https://codeclimate.com/github/vidaxl-com/cowlog/maintainability)
[![Greenkeeper badge](https://badges.greenkeeper.io/vidaxl-com/cowlog.svg)](https://greenkeeper.io/)
[![Known Vulnerabilities](https://snyk.io/test/github/vidaxl-com/cowlog/badge.svg?targetFile=packages%2Fdsl-framework%2Fpackage.json)](https://snyk.io/test/github/vidaxl-com/cowlog?targetFile=packages%2Fdsl-framework%2Fpackage.json)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvidaxl-com%2Fcowlog.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvidaxl-com%2Fcowlog?ref=badge_shield)

[![HitCount](http://hits.dwyl.com/vidaxl.com/cowlog.svg)](http://hits.dwyl.com/vidaxl-com/cowlog)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
<!--- destination qa rewrite end -->

# Installation
```bash
npm install array-dsl --save
```

# Motivation
This is project helps you to deal with arrays in a more functional/DLS way. This is also a presentation about how easy is to craft your own dsl with the help of the
**[dsl-framework](https://github.com/vidaxl-com/cowlog/tree/master/packages/dsl-framework)**
# Usage
I present the usage of the library with the example below; there are many ways to use it, let's start with the most
practically applicable one.

## Examples

```javascript 1.8
const example = [1,3,2,[4],[5,[6],6]]
const arrayDsl = require('array-dsl')

// flatten
let result = arrayDsl(example).flatten()
// [1,3,2,4,5,6,6]

// unique
result = arrayDsl(example).flatten.unique()
// [1,3,2,4,5,6]

// sort
result = arrayDsl(example).flatten.unique.sort()
// [1,2,3,4,5,6]

// sort
result = arrayDsl(example).flatten
  .unique.xor([1,7]).sort()
// [2,3,4,5,6,7]

// reverse
result = arrayDsl(example).flatten
  .unique.xor([1,7]).sort.reverse()
// [7,6,5,4,3,2]

// slice
result = arrayDsl(example).flatten
  .unique.xor([1,7]).sort().slice(1)()
// [3,4,5,6,7]

// randomItem
let randonItem = result = arrayDsl(example).flatten
  .unique.xor([1,7]).sort().slice(1).randomItem()
randonItem()
// this could return an item from the array [3,4,5,6,7]
// you can call it as much as you want

// union
result = arrayDsl(example).flatten
  .unique.xor([1,7]).sort().slice(1).union([1,8,2,3])()
// [1,2,3,4,5,6,7,8]

// union
result = arrayDsl([1,1,1,2,3,4,5]).union([1,8,2,3])()
// [1,2,3,4,5,8]

// if no arrify is called the same value/object is given back if it not an array
const notChanged2 = arrayDsl(3).unique.sort()
// 3


const rlastComplex = arrayDsl([1,1,1,2,3,4,5])
  .union([1,8,2,3]).last()
// 8

const first  = arrayDsl([1,2,3]).first()
// 1

// head is the alias of first
const head  = arrayDsl([1,2,3]).head()
// 1

// last
const last  = arrayDsl([1,2,3]).last()
// 3

// last + arrify
const lastAffify  = arrayDsl([1,2,3]).last.arrify()
// [3]

// Arrify transforms non array parameters to arrays
// https://www.npmjs.com/package/arrify
const arrify  = arrayDsl(3).arrify()
// [3]

const arrify  = arrayDsl(3).last.arrify()
// [3]

// if the parameter is not an array whatever 
// you do with it it will give back at the end 
// the variable you added to it.
const notChanged = arrayDsl(3)()
// 3

const flast  = arrayDsl([1,2,3]).tail()
// [1,2,3,4,5,8]
```

[d3-array](https://www.npmjs.com/package/d3-array) functions:

```javascript 1.8
const min = arrayDsl([1,2,3].min())
// 3

const max = arrayDsl([1,2,3].max())
// 3

const extent = arrayDsl([3,2,1].extent())
// [1,3]

const sum = arrayDsl([1,2,3].sum())
// 6

const median = arrayDsl([1,2,3].median())
// 2

const quantile = arrayDsl([0,10,1000,10000].quantile(0))
// 0

const variance = arrayDsl([0,10,1000,10000].variance())
const deviation = arrayDsl([0,10,1000,10000].deviation())
```

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