@pelevesque/sum-digits

0.0.10 • Public • Published

Build Status Coverage Status JavaScript Style Guide

sum-digits

Sums the digits in a string with a powerful substrings->digits feature.

Node Repository

https://www.npmjs.com/package/@pelevesque/sum-digits

Installation

npm install @pelevesque/sum-digits

Tests

Command Description
npm test or npm run test All Tests Below
npm run cover Standard Style
npm run standard Coverage
npm run unit Unit Tests

Usage

Parameters

str     (required)
options (optional) default = { substringsToDigits = null, sumPlainDigits = true }

Examples

const sumDigits = require('@pelevesque/sum-digits')
// normal summing
sumDigits('1234') // 10
// ignores non numeric characters
sumDigits('1a2!3_4.') // 10
// you can provide a hash table of substrings to digits
const substringsToDigits = { a: 1, b: 2, c: 3 }
sumDigits('1a2b3ca', { substringsToDigits: substringsToDigits }) // 13
// substrings can be of any length
const substringsToDigits = { '1p': 1000, panama: 100, nam: 10, 2: 1 }
sumDigits('1panama2', { substringsToDigits: substringsToDigits }) // 1114
// you can bypass plain digit summing and only use substringsToDigits summing
const substringsToDigits = { '1p': 1000, panama: 100, nam: 10, 2: 1 }
sumDigits('1panama2', { substringsToDigits: substringsToDigits, sumPlainDigits: false}) // 1111

Readme

Keywords

Package Sidebar

Install

npm i @pelevesque/sum-digits

Weekly Downloads

0

Version

0.0.10

License

MIT

Unpacked Size

12.6 kB

Total Files

6

Last publish

Collaborators

  • pelevesque