Skip to content

Commit

Permalink
fix(disk): Fix jsdoc comment on check method
Browse files Browse the repository at this point in the history
  • Loading branch information
BrunnerLivio committed Apr 7, 2019
1 parent a8478f5 commit bac4854
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions lib/health-indicators/disk/disk.health.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ export class DiskHealthIndicator extends HealthIndicator {
}

/**
* Checks if the given url respons in the given timeout
* and returns a result object corresponding to the result
* Checks if the size of the given size has exceeded the
* given threshold
*
* @param key The key which will be used for the result object
*
* @throws {HealthCheckError} In case the health indicator failed
Expand All @@ -99,9 +100,11 @@ export class DiskHealthIndicator extends HealthIndicator {
* @returns {Promise<HealthIndicatorResult>} The result of the health indicator check
*
* @example
* diskHealthIndicator.checkStorage('storage', { threshold: 120000000000, path: '/' });
* // The used disk storage should not exceed 250 GB
* diskHealthIndicator.check('storage', { threshold: 250 * 1024 * 1024 * 1024, path: '/' });
* @example
* diskHealthIndicator.checkSotrage('storage', { thresholdPercent: 0.5, path: 'C:\\' });
* // The used disk storage should not exceed 50% of the full disk size
* diskHealthIndicator.check('storage', { thresholdPercent: 0.5, path: 'C:\\' });
*/
async check(
key: string,
Expand Down

0 comments on commit bac4854

Please sign in to comment.