0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-04-01 02:41:39 -05:00

Added docs for currentCountQuery usage

refs https://github.com/TryGhost/Team/issues/597

- Documented example usacase for currentCountQuery override intoruced in previous commit
This commit is contained in:
Naz 2021-04-06 17:05:44 +12:00
parent f4f48712c5
commit 36dd9219c9

View file

@ -94,6 +94,24 @@ if (limitService.isLimited('members')) {
}
```
In case the limit check is run without direct access to the database you can override `currentCountQuery` functions for each "max" type of limit. An example usecase would be a frontend client running in a browser. A browser client can check the limit data through HTTP request and then provide that data to the limit service. Example code to do exactly that:
```
const limitService = new LimitService();
let limits = {
staff: {
max: 2,
currentCountQuery: async () => (await fetch('/api/staff')).json().length
}
};
limitService.loadLimits({limits, errors});
if (await limitService.checkIsOverLimit('staff')) {
// do something as "staff" limit has been reached
};
```
## Develop
This is a mono repository, managed with [lerna](https://lernajs.io/).