yearmap

Convert month ranges into a 12-month year map. 'may - july' → [0,0,0,0,1,1,1,0,0,0,0,0]

Usage no npm install needed!

<script type="module">
  import yearmap from 'https://cdn.skypack.dev/yearmap';
</script>

README

yearmap Build Status

Convert month ranges into a 12-month year map. 'may - july' → [0,0,0,0,1,1,1,0,0,0,0,0]

This module helps you take text-based month ranges, and convert them into parsable data arrays in the form of 12-month year maps. You can pass comma-delimited months and/or hyphenated month ranges. Hyphens are treated like a range, so yearmap reads 'may - july' as: 'may, june, july', and commas are used to separate the ranges and/or single months. See the tests for examples. Yearmap defaults to a binary-style map, but you can customize this behavior.

Install

$ npm install --save yearmap

Usage

const yearmap = require('yearmap');

yearmap('may - september');
//=> [0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0];

yearmap('january, february, december');
//=> [1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1];

yearmap('may - june, august - september');
//=> [0, 0, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0];

Automatic Year

If your string contains the keywords: year or annual then yearmap prints out the full year automatically:

yearmap('year-round');
//=> [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]

Modifiers

You can prepend the following modifiers to your months: early, late, mid, end. When modifiers are supplied, they are printed to the yearmap:

yearmap('late may - early june, end september - mid december');
//=> [0, 0, 0, 0, 'late', 'early', 0, 0, 'end', 1, 1, 'mid'];

Custom Output

The default is a binary-style yearmap, but you can change the way yearmap marks the 'on months' and 'off months' to customize your yearmap:

yearmap('december - february, may, june', {on:'yup', off: 'nope'});
//=> ['yup', 'yup', 'nope', 'nope', 'yup', 'yup', 'nope', 'nope', 'nope', 'nope', 'nope', 'nope']

API

yearmap(input, [options])

input

Type: string

The string containing month(s) or month ranges.

options

offMark

Type: string|number
Default: 0

The value you want to use when the month value is 'off'.

onMark

Type: string|number
Default: 1

The value you want to use when the month value is 'on'.

on

Type: string|number
Default: 1

Alias for onMark

off

Type: string|number
Default: 0

Alias for offMark

License

MIT © Michael Wuergler