Skip to content

Bindings and implementation for mutable JavaScript ArrayBuffers.

License

Notifications You must be signed in to change notification settings

purescript-contrib/purescript-arraybuffer

Repository files navigation

arraybuffer

CI Release Pursuit Maintainer: jacereda Maintainer: jamesdbrock

Bindings and implementation for mutable JavaScript ArrayBuffers.

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:

  1. Module documentation is published on Pursuit.
  2. Written documentation is kept in the docs directory.
  3. Usage examples can be found in the test suite.

If you get stuck, there are several ways to get help:

Contributing

You can contribute to arraybuffer in several ways:

  1. 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.

  2. 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.

  3. 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