feat: add isDuration validator

Author: os-moussao

src/index.js

@@ -14,6 +14,7 @@ import isIPRange from './lib/isIPRange';
 import isFQDN from './lib/isFQDN';
 import isDate from './lib/isDate';
 import isTime from './lib/isTime';
+import isDuration from './lib/isDuration';
 
 import isBoolean from './lib/isBoolean';
 import isLocale from './lib/isLocale';
@@ -245,6 +246,7 @@ const validator = {
   isLicensePlate,
   isVAT,
   ibanLocales,
+  isDuration,
 };
 
 export default validator;

src/lib/isDuration.js

@@ -0,0 +1,59 @@
+import assertString from './util/assertString';
+
+const BaseDurationUnits = [
+  'Years',
+  'Year',
+  'Yrs',
+  'Yr',
+  'Y',
+  'Weeks',
+  'Week',
+  'W',
+  'Days',
+  'Day',
+  'D',
+  'Hours',
+  'Hour',
+  'Hrs',
+  'Hr',
+  'H',
+  'Minutes',
+  'Minute',
+  'Mins',
+  'Min',
+  'M',
+  'Seconds',
+  'Second',
+  'Secs',
+  'Sec',
+  's',
+  'Milliseconds',
+  'Millisecond',
+  'Msecs',
+  'Msec',
+  'Ms',
+];
+
+const AllDurationUnits = new Set(BaseDurationUnits.flatMap(unit => [
+  unit, unit.toUpperCase(), unit.toLowerCase(),
+]));
+
+/**
+ * Checks if the string is a valid duration.
+ * It is designed to match the format used by the [ms](https://github.com/vercel/ms) package.
+ * The duration can be "1 week","2 days","1h", "30m", "15 s", etc.
+ */
+export default function isDuration(value) {
+  assertString(value);
+
+  // using the same number regex used in the `ms` package
+  const match = value.match(/^(?<nbr>-?(?:\d+)?\.?\d+)(?:\s?(?<unit>[a-zA-Z]+))?$/);
+
+  if (!match || !match.groups) {
+    return false;
+  }
+
+  const { unit } = match.groups;
+
+  return unit === undefined || AllDurationUnits.has(unit);
+}

test/validators/isDuration.test.js

@@ -0,0 +1,44 @@
+import { describe } from 'mocha';
+import test from '../testFunctions';
+
+describe('isDuration', () => {
+  it('should validate duration strings', () => {
+    test({
+      validator: 'isDuration',
+      valid: [
+        '1 week',
+        '2 days',
+        '1h',
+        '30m',
+        '15 s',
+        '100ms',
+        '1.5h',
+        '2.5 weeks',
+        '-1d',
+        '-200',
+      ],
+      invalid: [
+        '',
+        'abc',
+        '1 invalid',
+        'week 1',
+        '1.2.3h',
+        '+1h', // plus sign is not allowed as in `ms` package
+        '+200', // plus sign is not allowed as in `ms` package
+      ],
+    });
+  });
+
+  it('should accept various unit formats', () => {
+    test({
+      validator: 'isDuration',
+      valid: [
+        '1 Year',
+        '2 WEEKS',
+        '3 days',
+        '4H',
+        '5m',
+      ],
+    });
+  });
+});