JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 194869
  • Score
    100M100P100Q173278F
  • License MIT

micro module to require (versions of) modules that might not be there

Package Exports

  • semver-try-require

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (semver-try-require) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

What's this then?

A micro module that helps you to require (versions of) modules that might not be there. Useful to test for the availability of optional and peer dependencies before working with them.

The reason this module exists is to try a few non-standard things with the npm registry (deprecating, publishing betas, ...). Feel free to use it, though - semver-try-require works as advertised and is thoroughly tested.

Example

So you made the typescript compiler (v2) an optional dependency. But you just want to keep running if it ain't there.

Do this:

const tryRequire = require('semver-try-require');

// import typescript if there's a version >= 2 available
const typescript = tryRequire('typescript', '>=2');

// now you can test if typescript is actually there
const lProgram = 'const cube = x => x*x*x; console.log(cube(42))';

if (typescript !== false) {
    console.log(
        typescript.transpileModule(lProgram, {}).outputText
    );
    // Result:
    //   var cube = function (x) { return x * x * x; };
    //   console.log(cube(42));
} else {
    // typescript >=2 not found - use fallback
    console.log(
        lProgram
    );
    // Result:
    //    const cube = x => x*x*x; console.log(cube(42))
}

Signature

pModulename

The name of the module to resolve.

pSemVer

A semantic version (range). Optional.

return value

The (resolved) module identified by pModuleName if:

  • it is available, and
  • it satisfies the semantic version range specified by pSemVer

returns false in all other cases

License

MIT

Badge & flare section

Build Status npm stable version

Made with 🤘 in Holland