Package Exports

@stdlib/fs-read-wasm
@stdlib/fs-read-wasm/lib/index.js

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 (@stdlib/fs-read-wasm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Read WebAssembly

Read a file as WebAssembly.

Installation

npm install @stdlib/fs-read-wasm

Usage

var readWASM = require( '@stdlib/fs-read-wasm' );

readWASM( file[, options], clbk )

Asynchronously reads a file as WebAssembly.

var join = require( 'path' ).join;

var fpath = join( __dirname, 'examples', 'fixtures', 'file.wasm' );
readWASM( fpath, onRead );

function onRead( error, buf ) {
    if ( error ) {
        throw error;
    }
    console.log( buf );
}

The function accepts the following options:

flag: file status flag.

readWASM.sync( file[, options] )

Synchronously reads a file as WebAssembly.

var join = require( 'path' ).join;
var instanceOf = require( '@stdlib/assert-instance-of' );

var fpath = join( __dirname, 'examples', 'fixtures', 'file.wasm' );
var out = readWASM.sync( fpath );
if ( instanceOf( out, Error ) ) {
    throw out;
}
console.log( out );

The function accepts the same options as readWASM() above.

Notes

In contrast to readFile(), neither function accepts an encoding option. As WebAssembly is a binary file format, if provided an encoding option, the function overrides the option, setting the option value to null.
Both functions return WebAssembly file content as a Uint8Array.

Examples

var join = require( 'path' ).join;
var hasWebAssemblySupport = require( '@stdlib/assert-has-wasm-support' );
var readWASM = require( '@stdlib/fs-read-wasm' );

var fpath = join( __dirname, 'examples', 'fixtures', 'file.wasm' );
readWASM( fpath, onRead );

function onRead( error, wasm ) {
    var bool;
    if ( error ) {
        throw error;
    }
    bool = hasWebAssemblySupport();

    // If WebAssembly is supported, create a WebAssembly module instance...
    if ( bool ) {
        wasm = new WebAssembly.Module( wasm );
        wasm = new WebAssembly.Instance( wasm, {} );
        console.log( wasm.exports.stdlib_hypot( 5.0, 12.0 ) );
    } else {
        console.log( wasm );
    }
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/fs-read-wasm