Ghost/ghost/limit-service
2021-04-01 18:03:32 +13:00
..
lib Added optional max limit override to errorIfWouldGoOverLimit 2021-04-01 17:59:52 +13:00
test Grouped MaxLimit test cases into describe groups 2021-04-01 18:03:32 +13:00
.eslintrc.js
index.js
LICENSE
package.json
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

or

yarn add @tryghost/limit-service

Usage

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.

Run

  • yarn dev

Test

  • yarn lint run just eslint
  • yarn test run lint and tests

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.