TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-24 06:35:49 +03:00
Code Issues Projects Releases Wiki Activity

Improved docs around {{max}} & {{count}}

Browse Source 
refs https://github.com/TryGhost/Team/issues/587

- Improved description and provided example use of error message template variables that are available for "MaxLimit" types of limits
This commit is contained in:
Naz 2021-04-07 18:14:18 +12:00
parent 0f049fbb94
commit 4d6733b927
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
ghost/limit-service/README.md
View File

@ -95,7 +95,7 @@ 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: 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:
``` ```js
const limitService = new LimitService(); const limitService = new LimitService();
let limits = { let limits = {
@ -112,6 +112,17 @@ if (await limitService.checkIsOverLimit('staff')) {
}; };
``` ```
### Custom error messages
Errors returned by the limit service can be customized. When configuring the limit service through `loadLimits` method `limits` objects can specify an `error` property that is a template string. Additionally, "MaxLimit" limit type supports following variables- {{count}} and {{max}}.
An example configuration for "MaxLimit" limit using an error template can look like following:
```json
"staff": {
"max": 5,
"error": "Your plan supports up to {{max}} staff users and you currently have {{count}}. Please upgrade to add more."
}
```
## Develop ## Develop
This is a mono repository, managed with [lerna](https://lernajs.io/). This is a mono repository, managed with [lerna](https://lernajs.io/).