Awesome
arraybuffer
Bindings and implementation for mutable JavaScript ArrayBuffer
s.
An ArrayBuffer
is a built-in JavaScript object for storage of a flat continuous
region of memory.
The Typed
module provides a view into an ArrayBuffer
for array
access of aligned local-machine-endian types, for in-process flat memory operations.
The DataView
module provides a view into an ArrayBuffer
for inter-process
flat memory operations.
Installation
Install arraybuffer
with Spago:
spago install arraybuffer
Documentation
arraybuffer
documentation is stored in a few places:
- Module documentation is published on Pursuit.
- Written documentation is kept in the docs directory.
- Usage examples can be found in the test suite.
If you get stuck, there are several ways to get help:
- Open an issue if you have encountered a bug or problem.
- Ask general questions on the PureScript Discourse forum or the PureScript Discord chat.
Contributing
You can contribute to arraybuffer
in several ways:
-
If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.
-
If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.
-
If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.
Usage
Polyfill
This library relies on runtime implementations of
ArrayBuffer
and
DataView
(Structured Data),
and
TypedArray
(Indexed Collections).
If you want to be sure that those implementations are available in your target runtime environment, you might want to consider using a polyfill such as core-js Typed Arrays.
Related packages
These are some other packages which provide more ArrayBuffer
features.
Reading and Writing
Node.js
UTF
Base64
Development
Run the tests with
spago -x spago-test.dhall test