func-cache - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

package.json

		{
		"name": "func-cache",
		"version": "2.1.0",
		"version": "2.1.1",
		"license": "MIT",
		@@ -8,2 +8,8 @@ "main": "dist/index.js",
		"description": "TypeScript library for caching static functions",
		"keywords": [
		"cache",
		"redis",
		"memory",
		"upstash"
		],
		"files": [
		@@ -80,4 +86,5 @@ "dist/*/",
		"./tools/upstash": "./tools/upstash.ts",
		"./tools": "./tools"
		"./tools": "./tools",
		"./d/types.d": "./d/types.d"
		}
		}
		}

120

README.md

		@@ -1,103 +0,67 @@
		# TSDX User Guide
		# Fun cache

		Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
		This is the fun and cache.

		> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
		# How does it work:

		> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)
		It stores a map of results of a function and uses arguments as keys, for faster response,

		## Commands
		Note that if the function result in different results with the same argument, the cache wouldn't work.

		TSDX scaffolds your new library inside `/src`.
		# How to use:

		To run TSDX, use:
		```ts
		import funcache from "func-cache";

		```bash
		npm start # or yarn start
		```
		const cachedFibonacci = funcache((num: number) => {
		// ... your function here
		}, options); // about the options, see below

		This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.

		To do a one-off build, use `npm run build` or `yarn build`.
		console.log(cachedFibonacci(1000)); //-- viewing the result

		To run tests, use `npm test` or `yarn test`.
		console.log(cachedFibonacci.noCache(1000)); //-- run without caching

		## Configuration

		Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.

		### Jest

		Jest tests are set up to run with `npm test` or `yarn test`.

		### Bundle Analysis

		[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.

		#### Setup Files

		This is the folder structure we set up for you:

		```txt
		/src
		index.tsx # EDIT THIS
		/test
		blah.test.tsx # EDIT THIS
		.gitignore
		package.json
		README.md # EDIT THIS
		tsconfig.json
		console.log(cachedFibonacci.clearCache()); //-- to clear the cache
		```

		### Rollup

		TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
		# Options:

		### TypeScript
		```ts
		import fSCacher from "func-cache/tools/fs"; // only for server
		import redisCacher from "func-cache/tools/redis"; // only for server
		import upstashCacher from "func-cache/tools/upstash"; // only for server

		`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
		import funcache, { localStorageCacher } from "func-cache";

		## Continuous Integration
		const options = {
		// (1 sec) in miliseconds
		lifeTime: 1000,

		### GitHub Actions
		/** debounce time wait to call onDataUpdate, default 1000ms */
		debounceTimer: 200,

		Two actions are added by default:
		/** incase the call is async, (sometimes the script doesn't detect it's async and wont run the await for it) default: false */
		async: true,

		- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
		- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)

		## Optimizations

		// place to store the cache, incase of restarts (browser only)
		...localStorageCacher("_cachePlace_for_fibonacci"),

		Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
		// place to store the cache, incase of restarts (server only). fs way
		...fSCacher("./_cachePlace_for_fibonacci.json"),

		```js
		// ./types/index.d.ts
		declare var __DEV__: boolean;
		// place to store the cache, incase of restarts (server only). redis way
		...redisCacher("_cachePlace_for_fibonacci", {
		client: redisClient,
		}),

		// inside your code...
		if (__DEV__) {
		console.log('foo');
		}
		```
		// place to store the cache, incase of restarts (server only). upstash way
		...upstashCacher("_cachePlace_for_fibonacci", {
		client: upstashClient,
		}),
		};

		You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.

		## Module Formats

		CJS, ESModules, and UMD module formats are supported.

		The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.

		## Named Exports

		Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.

		## Including Styles

		There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.

		For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.

		## Publishing to NPM

		We recommend using [np](https://github.com/sindresorhus/np).
		```

src/d/types.d.ts

func-cache - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics