fn-getter - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

package.json

 {
   "name": "fn-getter",
-  "description": "Simple. lazyily evaluated values",
-  "version": "0.0.0",
+  "description": "Simple, lazyily evaluated values.",
+  "version": "1.0.0",
   "author": "Jonathan Ong <[e-mail]> (http://jongleberry.com)",
@@ -6,0 +6,0 @@ "license": "MIT",

README.md

 
 # fn-getter
 
-Simple. lazyily evaluated values.
-
 [![NPM version][npm-image]][npm-url]
@@ -13,2 +11,30 @@ [![Build status][travis-image]][travis-url]
 
+Simple, lazyily evaluated values.
+If a value takes too long to calculate,
+but you don't need it right away (ex. on startup),
+then evaluate lazily.
+
+```js
+const createGetter = require('fn-getter')
+
+const createS3Client = createGetter(() => {
+  const AWS = require('aws-sdk')
+  return new AWS.S3()
+})
+```
+
+Maybe you want to evaluate it after the first time:
+
+```js
+setImmediate(createS3Client)
+```
+
+Then, when you need to use it:
+
+```js
+app.use((req, res, next) => {
+  createS3Client().putObject(...)
+})
+```
+
 [npm-image]: https://img.shields.io/npm/v/fn-getter.svg?style=flat-square
@@ -15,0 +41,0 @@ [npm-url]: https://npmjs.org/package/fn-getter

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3699

increased by14.66%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

51

increased by104%

No dependency changes