TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-25 03:44:29 +03:00
Code Issues Projects Releases Wiki Activity

Improved JSDocs in limit package

Browse Source 
no issue

- There were a few errors and little inconsistencies that needed a cleanup
This commit is contained in:
Naz 2021-10-26 11:23:42 +04:00
parent aef6c19933
commit 9c695a363c
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ghost/limit-service/lib/limit.js
View File

@ -46,8 +46,8 @@ class MaxLimit extends Limit {
* @param {Number} options.config.max - maximum limit the limit would check against
* @param {Function} options.config.currentCountQuery - query checking the state that would be compared against the limit
* @param {String} [options.config.error] - error message to use when limit is reached
* @param {String} options.helpLink - URL to the resource explaining how the limit works
* @param {Object} options.db - instance of knex db connection that currentCountQuery can use to run state check through
* @param {String} [options.helpLink] - URL to the resource explaining how the limit works
* @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
* @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
*/
constructor({name, config, helpLink, db, errors}) {
@ -136,7 +136,7 @@ class MaxPeriodicLimit extends Limit {
* @param {('month')} options.config.interval - an interval to take into account when checking the limit. Currently only supports 'month' value
* @param {String} options.config.startDate - start date in ISO 8601 format (https://en.wikipedia.org/wiki/ISO_8601), used to calculate period intervals
* @param {String} options.helpLink - URL to the resource explaining how the limit works
* @param {Object} options.db - instance of knex db connection that currentCountQuery can use to run state check through
* @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
* @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
*/
constructor({name, config, helpLink, db, errors}) {
@ -238,7 +238,7 @@ class FlagLimit extends Limit {
* @param {Number} options.config.disabled - disabled/enabled flag for the limit
* @param {String} options.config.error - error message to use when limit is reached
* @param {String} options.helpLink - URL to the resource explaining how the limit works
* @param {Object} options.db - instance of knex db connection that currentCountQuery can use to run state check through
* @param {Object} [options.db] - instance of knex db connection that currentCountQuery can use to run state check through
* @param {Object} options.errors - instance of errors compatible with Ghost-Ignition's errors (https://github.com/TryGhost/Ignition#errors)
*/
constructor({name, config, helpLink, db, errors}) {