pions

THIS PROJECT IS STILL IN THE DESIGN PHASE

IDEAS & CONTRIBUTIONS ARE WELCOME

An Open Source Universe Project

---

Contents

• pions
  • Contents
  • Features ✨
  • Install 🛠
  • Usage 🔭
  • Documentation 🛰
  • Contributing 🌎
  • License ⚖️

Features ✨

• Mapping Functions Planned
• Aggregation Functions Planned
• Reduce Functions Planned
• Typescript Support Planned

Install 🛠

npm install pions

Usage 🔭

Read more about the Design behind pions here.

import { reduceOverValues } from 'pions';

const data = {
  'Group 1': [1,2,3,4,...],
  'Group 2': [1,1,2,3,...],
  'Group 3': [1,4,9,16,...],
}

const counts = reduceOverValues(data, ({ value }) => value.length)
// { 'Group 1': 50, 'Group 2': 15, 'Group 3': 32 }

const sums = reduceOverValues(data, ({ aggregate, value }) => aggregate + value)
// { 'Group 1': 1275, 'Group 2': 1596, 'Group 3': 11440 }

Documentation 🛰

pions is under active development, documentation will be added once an initial release is ready.

Contributing 🌎

We would love for you to contribute your ideas, code, & fixes to pions.

We encourage everyone to read our Design Document to learn more about the thought process behind pions.

Also check out the rewards offered for contributing to the Open Source Universe.

License ⚖️

MIT