JSPM

@programmerraj/sokk

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 49
  • Score
    100M100P100Q25047F
  • License MIT

Round/ceil/float to any integer multiple

Package Exports

  • @programmerraj/sokk

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@programmerraj/sokk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

sokk

A TypeScript library to round/ceil/floor to a nearby multiple

Example

import {round, float, ceil} from 'sokk';

# round to the nearest integer
# prints 1
console.log(round(1.2))

# round to the nearest multiple of 6
# prints '12'
console.log(round(11, 6))

# round down to the nearest integer
# prints 3
console.log(floor(3.3))

# round to the next lowest multiple of 5
# prints 15
console.log(floor(18, 5))

# round up to the nearest integer
# prints 5
console.log(ceil(4.9, 5))

# round up to the next highest multiple of 7
# prints 21
console.log(ceil(20, 7))

Why?

Naming things is hard, and I use this library as part of a knitted sock pattern generator, where there is need to round stitch counds to groups of commonly 2 or 4 stitches.

sokk is Norweigan for sock (I use an old Norse cast on for my socks)