Skip to content

Commit 70d9fb3

Browse files
committed
document preload and exported modules
1 parent bb36c98 commit 70d9fb3

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,62 @@ semver.valid(semver.coerce('v2')) // '2.0.0'
2525
semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7'
2626
```
2727

28+
This module uses getters to lazily load only the parts of the package that
29+
are used. To use it with Webpack and other projects that need string
30+
literals as the argument to `require()`, load it this way:
31+
32+
```js
33+
// load the whole API at once in a single object
34+
const semver = require('semver/preload')
35+
36+
// or just load the bits you need
37+
// all of them listed here, just pick and choose what you want
38+
39+
// classes
40+
const SemVer = require('semver/classes/semver')
41+
const Comparator = require('semver/classes/comparator')
42+
const Range = require('semver/classes/range')
43+
44+
// functions for working with versions
45+
const semverParse = require('semver/functions/parse')
46+
const semverValid = require('semver/functions/valid')
47+
const semverClean = require('semver/functions/clean')
48+
const semverInc = require('semver/functions/inc')
49+
const semverDiff = require('semver/functions/diff')
50+
const semverMajor = require('semver/functions/major')
51+
const semverMinor = require('semver/functions/minor')
52+
const semverPatch = require('semver/functions/patch')
53+
const semverPrerelease = require('semver/functions/prerelease')
54+
const semverCompare = require('semver/functions/compare')
55+
const semverRcompare = require('semver/functions/rcompare')
56+
const semverCompareLoose = require('semver/functions/compare-loose')
57+
const semverCompareBuild = require('semver/functions/compare-build')
58+
const semverSort = require('semver/functions/sort')
59+
const semverRsort = require('semver/functions/rsort')
60+
61+
// low-level comparators between versions
62+
const semverGt = require('semver/functions/gt')
63+
const semverLt = require('semver/functions/lt')
64+
const semverEq = require('semver/functions/eq')
65+
const semverNeq = require('semver/functions/neq')
66+
const semverGte = require('semver/functions/gte')
67+
const semverLte = require('semver/functions/lte')
68+
const semverCmp = require('semver/functions/cmp')
69+
const semverCoerce = require('semver/functions/coerce')
70+
71+
// working with ranges
72+
const semverSatisfies = require('semver/functions/satisfies')
73+
const semverMaxSatisfying = require('semver/ranges/max-satisfying')
74+
const semverMinSatisfying = require('semver/ranges/min-satisfying')
75+
const semverToComparators = require('semver/ranges/to-comparators')
76+
const semverMinVersion = require('semver/ranges/min-version')
77+
const semverValidRange = require('semver/ranges/valid')
78+
const semverOutside = require('semver/ranges/outside')
79+
const semverGtr = require('semver/ranges/gtr')
80+
const semverLtr = require('semver/ranges/ltr')
81+
const semverIntersects = require('semver/ranges/intersects')
82+
```
83+
2884
As a command-line utility:
2985

3086
```

0 commit comments

Comments
 (0)