@modern-kit/utils/dist/validator/isNumeric/index.d.ts

modern-kit/utils

interface Options {
    sign?: boolean;
}
/**
 * @description 문자열이 숫자만으로 이루어졌는지 확인합니다.
 *
 * @param {string} value - 숫자만으로 이루어졌는지 확인할 문자열.
 * @param {Options} options
 * @property {boolean} sign - "-" 및 "." 기호를 포함 할 것인지 여부를 포함한 옵션입니다.
 * @returns {boolean} - 문자열이 숫자만으로 이루어졌다면 `true`, 그렇지 않다면 `false`를 반환합니다.
 *
 * @example
 * isNumeric("12345"); // true
 *
 * isNumeric("123a45"); // false
 * isNumeric(""); // false
 *
 * @example
 * isNumeric("123.45", { sign: true }); // true
 * isNumeric("-123", { sign: true }); // true
 *
 * isNumeric('12-345', { sign: true }); // false, ("-" 기호는 문자열 가장 앞에만 붙일 수 있음)
 * isNumeric("1245.", { sign: true }); // false, (소수점 뒤에 숫자가 없음)
 */
declare function isNumeric(value: string, options?: Options): boolean;

export { isNumeric };