Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

sumtin

v0.0.2

Published

2 years ago

Referentially tranparent random generation functions

Downloads

5

0High
0Medium
0Low

Sumtin

Referentially tranparent random generation functions

Reasoning

Referential transparency is nice. What I was missing was a simple random generation library that works predictably.

This is achieved by passing the random function as an argument. It leaves it up to you to use Math.random or your favorite pseudo random function instead.

API

All random generation functions take a random function as its first argument.

For convenience sake, sumtin exports a function as the default value. This function will return an object that contains the random generation functions. These functions have the random function bound as the first argument.

const assert = require('assert')
const {pick} = require('sumtin')(() => 0)

assert.equal(pick([1,2,3]), 1)

The pick function will always return the first value because the "random" function will always return 0. This will result in the item located at index 0 to be returned. You wouldn't do this normally.

We could also pass the Math.random function. You could pass in any function that returns a number between and including 0 and 1. Maybe you want to reproduce the same "random" values. You can instead pass in your favorite psuedorandom function. Maybe the seed-random's function.

`something(rand)`

source tests edit

Picks a random function and returns a random value from that function

`boolean(rand)`

source tests edit

Returns true whenever the rand function returns a value lower than or equal to 0.5. Otherwise returns false

`char(rand)`

source tests edit

Generate a random char. It uses the Javascript String.fromCodePoint() to achieve this.

`date(rand)`

source tests edit

Creates a date between the Javascript minimum and maximum allowed dates.

The earliest date being -271821-04-20T00:00:00.000Z

The latest date being +275760-09-13T00:00:00.000Z

`digit(rand)`

source tests edit

A numeric digit which is a number between 0 and 9

`falsy(rand)`

source tests edit

This will return one of the following values: null, undefined, false, 0, '' and NaN.

You can read more about javascript falsy values over at Mozilla's falsy documentation

`futureDate(rand)`

source tests edit

A future date returns a date that has occurred after the now date. The now date is created when the module is evaluated. As a result a future can become a date from the past if the lifecycle of the application increases.

`hexadecimalDigit(rand)`

source tests edit

TBD

`hexColor(rand)`

source tests edit

TBD

`integer(rand)`

source tests edit

Return a whole number between and including the numbers 9007199254740991 and -9007199254740991

`letter(rand)`

source tests edit

TBD

`letters(rand, length = () => 20)`

source tests edit

TBD

`negativeInteger(rand)`

source tests edit

Return a whole number between and including the numbers -1 and -9007199254740991

`negativeNumber(rand)`

source tests edit

TBD

`number(rand)`

source tests edit

TBD

`pastDate(rand)`

source tests edit

TBD

`pick(rand, items = [])`

source tests edit

TBD

`positiveInteger(rand)`

source tests edit

Return a whole number between and including the numbers 1 and 9007199254740991

`positiveNumber(rand)`

source tests edit

Return a number between and including the numbers 1 and 9007199254740991

`rangedDate(rand, range = [new Date(-1), new Date(1)])`

source tests edit

TBD

`rangedInteger(rand, range)`

source tests edit

Returns a integer between the range. The max value is never returned. Under the hood it will retry getting a value if the value equals the max value

`rangedNumber(rand, range = [-1, 1])`

source tests edit

TBD

`sometimes(rand, doFn = v => v, value, ratio = 0.5)`

source tests edit

Performs a function whenever the random value is greater than the ratio argument.

This is used both internally and could be used to apply functions "sometimes"

Tests

Something relies on tests to prove that randomly generated values are indeed random enough but not so random that it's useless. The goal is to keep test coverage at 100%.

You can run the tests yourself with npm t

Coverage

----------------------------|----------|----------|----------|----------|-------------------|
File                        |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------------------------|----------|----------|----------|----------|-------------------|
All files                   |      100 |      100 |      100 |      100 |                   |
 lib                        |      100 |      100 |      100 |      100 |                   |
  helpers.js                |      100 |      100 |      100 |      100 |                   |
  helpers.spec.js           |      100 |      100 |      100 |      100 |                   |
  index.js                  |      100 |      100 |      100 |      100 |                   |
  index.spec.js             |      100 |      100 |      100 |      100 |                   |
 lib/function               |      100 |      100 |      100 |      100 |                   |
  boolean.js                |      100 |      100 |      100 |      100 |                   |
  boolean.spec.js           |      100 |      100 |      100 |      100 |                   |
  char.js                   |      100 |      100 |      100 |      100 |                   |
  char.spec.js              |      100 |      100 |      100 |      100 |                   |
  date.js                   |      100 |      100 |      100 |      100 |                   |
  date.spec.js              |      100 |      100 |      100 |      100 |                   |
  digit.js                  |      100 |      100 |      100 |      100 |                   |
  digit.spec.js             |      100 |      100 |      100 |      100 |                   |
  falsy.js                  |      100 |      100 |      100 |      100 |                   |
  falsy.spec.js             |      100 |      100 |      100 |      100 |                   |
  future-date.js            |      100 |      100 |      100 |      100 |                   |
  future-date.spec.js       |      100 |      100 |      100 |      100 |                   |
  hex-color.js              |      100 |      100 |      100 |      100 |                   |
  hex-color.spec.js         |      100 |      100 |      100 |      100 |                   |
  hexadecimal-digit.js      |      100 |      100 |      100 |      100 |                   |
  hexadecimal-digit.spec.js |      100 |      100 |      100 |      100 |                   |
  integer.js                |      100 |      100 |      100 |      100 |                   |
  integer.spec.js           |      100 |      100 |      100 |      100 |                   |
  letter.js                 |      100 |      100 |      100 |      100 |                   |
  letter.spec.js            |      100 |      100 |      100 |      100 |                   |
  letters.js                |      100 |      100 |      100 |      100 |                   |
  letters.spec.js           |      100 |      100 |      100 |      100 |                   |
  negative-integer.js       |      100 |      100 |      100 |      100 |                   |
  negative-integer.spec.js  |      100 |      100 |      100 |      100 |                   |
  negative-number.js        |      100 |      100 |      100 |      100 |                   |
  negative-number.spec.js   |      100 |      100 |      100 |      100 |                   |
  number.js                 |      100 |      100 |      100 |      100 |                   |
  number.spec.js            |      100 |      100 |      100 |      100 |                   |
  past-date.js              |      100 |      100 |      100 |      100 |                   |
  past-date.spec.js         |      100 |      100 |      100 |      100 |                   |
  pick.js                   |      100 |      100 |      100 |      100 |                   |
  pick.spec.js              |      100 |      100 |      100 |      100 |                   |
  positive-integer.js       |      100 |      100 |      100 |      100 |                   |
  positive-integer.spec.js  |      100 |      100 |      100 |      100 |                   |
  positive-number.js        |      100 |      100 |      100 |      100 |                   |
  positive-number.spec.js   |      100 |      100 |      100 |      100 |                   |
  ranged-date.js            |      100 |      100 |      100 |      100 |                   |
  ranged-date.spec.js       |      100 |      100 |      100 |      100 |                   |
  ranged-integer.js         |      100 |      100 |      100 |      100 |                   |
  ranged-integer.spec.js    |      100 |      100 |      100 |      100 |                   |
  ranged-number.js          |      100 |      100 |      100 |      100 |                   |
  ranged-number.spec.js     |      100 |      100 |      100 |      100 |                   |
  sometimes.js              |      100 |      100 |      100 |      100 |                   |
  sometimes.spec.js         |      100 |      100 |      100 |      100 |                   |
----------------------------|----------|----------|----------|----------|-------------------|

Support

The following node versions are supported.

4
5
6
7
8
9
10

Most of these versions are supported thanks to babel transpile.