History

Naz 57e24b3677 Added incorrect 'max' usage error to MaxLimit refs https://github.com/TryGhost/Team/issues/587 - When the 'max' configuration is missing the instance of the class breaks when used unexpectedly. Followed similar approach to currentCountQuery check by failing fast in the constructor		2021-04-01 17:20:56 +13:00
..
lib	Added incorrect 'max' usage error to MaxLimit	2021-04-01 17:20:56 +13:00
test	Added incorrect 'max' usage error to MaxLimit	2021-04-01 17:20:56 +13:00
.eslintrc.js	Added limit service initial commit	2021-03-03 12:19:48 +00:00
index.js	Added limit service initial commit	2021-03-03 12:19:48 +00:00
LICENSE	Added limit service initial commit	2021-03-03 12:19:48 +00:00
package.json	Published new versions	2021-03-04 20:46:49 +00:00
README.md	Updated readme with module description	2021-03-31 13:05:46 +13:00

Limit Service

This module is intended to hold all of the logic for testing if site:

would be over a given limit if they took an action (i.e. added one more thing, switched to a different limit)
if they are over a limit already
consistent error messages explaining why the limit has been reached

Install

npm install @tryghost/limit-service --save

yarn add @tryghost/limit-service

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.