surrange

surrange is a simple utility for generating ranges that surround a given number.

Install

npm install surrange

Example

var surrange = require('surrange')
 
surrange(10, 5)
// => [8, 9, 10, 11, 12, 13]
 
surrange(-1, 10)
// => [-6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4]
 
surrange(-1, 10, { minimum: 1 })
// => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]

API

surrange(

  number (int):
    any integer, positive or negative.

  surround (int):
    the number of surrounding values that should
    be included in the output. odd values will be
    weighted to the right by default.

  options (object):

    minimum (int):
      sets a minimum bound on the output range. the
      surround parameter will be satisfied by adding
      additional numbers to right until the (optional)
      maximum is reached.

    maximum (int):
      like above, but in reverse.

    weight: (int):
      any negative value will weight the range to the
      left if an odd surround parameter is provided.

)

License

MIT