This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@stdlib/dist-flat

stdlib

Standard library for JavaScript.

Usage

var stdlib = require( '@stdlib/dist-flat' );

stdlib.<name>

Top-level interfaces which provide ergonomic APIs and strive for generality. These interfaces are particularly useful in REPL environments, where input arguments may be provided ad-hoc and require more immediate validation.

stdlib.base.<name>

Lower-level interfaces which are often tailored to particular argument types and eschew input argument validation and other sanity checks. These interfaces are useful when building performance-critical applications and when arguments are of a known type and validity.

---

Notes

• A flat namespace uses the global alias namespace, where each package has a unique alias (e.g., stdlib.base.erf).

• This package contains distributable files for use in browser environments or as shared ("vendored") libraries in server environments. Each distributable file is a standalone UMD bundle which, if no recognized module system is present, will expose bundle contents to the global scope.

• Each minified bundle has a corresponding gzip-compressed bundle. The gzip compression level for each compressed bundle is 9, which is the highest (and most optimal) compression level. Deciding between uncompressed and compressed bundles depends on the application and whether compression is handled elsewhere in the application stack (e.g., nginx, CDN, et cetera).

• While you are strongly encouraged to vendor bundles and host with a CDN/provider which can provide availability guarantees, especially for production applications, bundles are available via unpkg for quick demos, proof-of-concepts, and instructional material. For example,

  <script type="text/javascript" src="https://unpkg.com/@stdlib/dist-flat"></script>

  Please be mindful that unpkg is a free, best-effort service relying on donated infrastructure which does not provide any availability guarantees. Under no circumstances should you abuse or misuse the service. You have been warned.

• If you intend on embedding a standalone bundle within another bundle, you may need to rename require calls within the standalone bundle before bundling in order to maintain scoped module resolution. For example, if you plan on using browserify to generate a bundle containing embedded bundles, browserify plugins exist to "de-require" those bundles prior to bundling.

• The bundles in this package expose all browser-compatible stdlib packages, except the following:

  • @stdlib/repl: REPL environment.
  • @stdlib/namespace: global alias namespace.
  • @stdlib/datasets/*: datasets.

  The excluded packages can significantly inflate bundle size, and, if desired, should be bundled and sourced separately.

---

Examples

var stdlib = require( '@stdlib/dist-flat' );

var y = stdlib.base.erf( 0.5 );
console.log( y );

To include the bundle in a webpage,

<script type="text/javascript" src="/path/to/@stdlib/dist-flat/build/bundle.min.js"></script>

If no recognized module system is present, access bundle contents via the global scope.

<script type="text/javascript">
    // If no recognized module system present, exposed to global scope:
    var erf = stdlib_flat.base.erf;
    console.log( erf( 0.5 ) );
</script>