https://github.com/stdlib-js/fs-read-wasm
Read a file as WebAssembly.
https://github.com/stdlib-js/fs-read-wasm
async file filesystem fs javascript node node-js nodejs open path read readfile readfilesync stdlib sync wasm webassembly
Last synced: about 1 year ago
JSON representation
Read a file as WebAssembly.
- Host: GitHub
- URL: https://github.com/stdlib-js/fs-read-wasm
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T17:08:10.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T06:14:45.000Z (over 1 year ago)
- Last Synced: 2025-03-20T07:44:12.295Z (about 1 year ago)
- Topics: async, file, filesystem, fs, javascript, node, node-js, nodejs, open, path, read, readfile, readfilesync, stdlib, sync, wasm, webassembly
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 876 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
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
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Read a file as [WebAssembly][webassembly].
## Installation
```bash
npm install @stdlib/fs-read-wasm
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var readWASM = require( '@stdlib/fs-read-wasm' );
```
#### readWASM( file\[, options], clbk )
Asynchronously reads a file as [WebAssembly][webassembly].
```javascript
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][webassembly].
```javascript
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()`](#read-wasm) above.
## Notes
- In contrast to [`readFile()`][@stdlib/fs/read-file], neither function accepts an `encoding` option. As [WebAssembly][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][webassembly] file content as a [`Uint8Array`][@stdlib/array/uint8].
## Examples
```javascript
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 );
}
}
```
* * *
## See Also
- [`@stdlib/fs-read-file`][@stdlib/fs/read-file]: read the entire contents of a file.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/fs-read-wasm.svg
[npm-url]: https://npmjs.org/package/@stdlib/fs-read-wasm
[test-image]: https://github.com/stdlib-js/fs-read-wasm/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/fs-read-wasm/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-read-wasm/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/fs-read-wasm?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/fs-read-wasm/tree/deno
[deno-readme]: https://github.com/stdlib-js/fs-read-wasm/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/fs-read-wasm/tree/umd
[umd-readme]: https://github.com/stdlib-js/fs-read-wasm/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/fs-read-wasm/tree/esm
[esm-readme]: https://github.com/stdlib-js/fs-read-wasm/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/fs-read-wasm/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-read-wasm/main/LICENSE
[webassembly]: https://webassembly.org/
[@stdlib/fs/read-file]: https://github.com/stdlib-js/fs-read-file
[@stdlib/array/uint8]: https://github.com/stdlib-js/array-uint8