@@ -430,7 +430,9 @@ any other overlapping SemVer tuple.
430
430
431
431
* ` clean(version) ` : Clean a string to be a valid semver if possible
432
432
433
- This will return a cleaned and trimmed semver version. If the provided version is not valid a null will be returned. This does not work for ranges.
433
+ This will return a cleaned and trimmed semver version. If the provided
434
+ version is not valid a null will be returned. This does not work for
435
+ ranges.
434
436
435
437
ex.
436
438
* ` s.clean(' = v 2.1.5foo') ` : ` null `
441
443
* ` s.clean(' =v2.1.5') ` : ` 2.1.5 `
442
444
* ` s.clean(' 2.1.5 ') ` : ` '2.1.5' `
443
445
* ` s.clean('~1.0.0') ` : ` null `
446
+
447
+ ## Exported Modules
448
+
449
+ <!--
450
+ TODO: Make sure that all of these items are documented (classes aren't,
451
+ eg), and then pull the module name into the documentation for that specific
452
+ thing.
453
+ -->
454
+
455
+ You may pull in just the part of this semver utility that you need, if you
456
+ are sensitive to packing and tree-shaking concerns. The main
457
+ ` require('semver') ` export uses getter functions to lazily load the parts
458
+ of the API that are used.
459
+
460
+ The following modules are available:
461
+
462
+ * ` require('semver') `
463
+ * ` require('semver/classes') `
464
+ * ` require('semver/classes/comparator') `
465
+ * ` require('semver/classes/range') `
466
+ * ` require('semver/classes/semver') `
467
+ * ` require('semver/functions/clean') `
468
+ * ` require('semver/functions/cmp') `
469
+ * ` require('semver/functions/coerce') `
470
+ * ` require('semver/functions/compare') `
471
+ * ` require('semver/functions/compare-build') `
472
+ * ` require('semver/functions/compare-loose') `
473
+ * ` require('semver/functions/diff') `
474
+ * ` require('semver/functions/eq') `
475
+ * ` require('semver/functions/gt') `
476
+ * ` require('semver/functions/gte') `
477
+ * ` require('semver/functions/inc') `
478
+ * ` require('semver/functions/lt') `
479
+ * ` require('semver/functions/lte') `
480
+ * ` require('semver/functions/major') `
481
+ * ` require('semver/functions/minor') `
482
+ * ` require('semver/functions/neq') `
483
+ * ` require('semver/functions/parse') `
484
+ * ` require('semver/functions/patch') `
485
+ * ` require('semver/functions/prerelease') `
486
+ * ` require('semver/functions/rcompare') `
487
+ * ` require('semver/functions/rsort') `
488
+ * ` require('semver/functions/satisfies') `
489
+ * ` require('semver/functions/sort') `
490
+ * ` require('semver/functions/valid') `
491
+ * ` require('semver/ranges/gtr') `
492
+ * ` require('semver/ranges/intersects') `
493
+ * ` require('semver/ranges/ltr') `
494
+ * ` require('semver/ranges/max-satisfying') `
495
+ * ` require('semver/ranges/min-satisfying') `
496
+ * ` require('semver/ranges/min-version') `
497
+ * ` require('semver/ranges/outside') `
498
+ * ` require('semver/ranges/to-comparators') `
499
+ * ` require('semver/ranges/valid') `
0 commit comments