Skip to content

Commit 0e7f900

Browse files
committed
Rename @return to @RenameS
1 parent 06f938e commit 0e7f900

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

src/formatMoney.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { formatNumber } from './formatNumber';
2828
*
2929
* @param {Number} amount - Amount to be formatted
3030
* @param {Object} [opts={}] - Object containing all the options of the method
31-
* @return {String} - Given number properly formatted as money
31+
* @returns {String} - Given number properly formatted as money
3232
*/
3333
export function formatMoney(amount: number, opts: Settings = {}): string {
3434
// Build options object from second param (if object) or all params, extending defaults

src/formatNumber.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { toFixed } from './toFixed';
2020
*
2121
* @param {Number} number - Number to be formatted
2222
* @param {Object} [opts={}] - Object containing all the options of the method
23-
* @return {String} - Given number properly formatted
23+
* @returns {String} - Given number properly formatted
2424
*/
2525
export function formatNumber(number: number, opts: Settings = {}): string {
2626
// Build options object from second param (if object) or all params, extending defaults

src/toFixed.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import { settings } from './settings';
2121
* @param {Float} value - Float to be treated as a decimal number
2222
* @param {Number} [precision=settings.precision] - Number of decimal digits to keep
2323
* @param {Number} [round=settings.round] - Decide round direction
24-
* @return {String} - Given number transformed into a string with the given precission
24+
* @returns {String} - Given number transformed into a string with the given precission
2525
*/
2626
export function toFixed(value: number, precision?: number, round?: number): string {
2727
precision ??= settings.precision!;

src/unformat.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { settings } from './settings';
2222
* @param {String} value - String containing the number to parse
2323
* @param {String} [decimal=settings.decimal] - The character used to represent the decimal separator
2424
* @param {Float} [fallback=settings.fallback] - Value returned on unformat() failure
25-
* @return {Float} - Parsed number
25+
* @returns {Float} - Parsed number
2626
*/
2727

2828
export function unformat(value: string, decimal: string = settings.decimal!, fallback: number = settings.fallback!): number {

0 commit comments

Comments
 (0)