https://github.com/purescript-contrib/purescript-arraybuffer-types

Type definitions for JavaScript ArrayBuffers
https://github.com/purescript-contrib/purescript-arraybuffer-types

Last synced: about 1 year ago
JSON representation

Type definitions for JavaScript ArrayBuffers

• Host: GitHub
• URL: https://github.com/purescript-contrib/purescript-arraybuffer-types
• Owner: purescript-contrib
• License: mit
• Created: 2015-02-24T22:54:14.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2022-04-27T15:18:12.000Z (almost 4 years ago)
• Last Synced: 2025-03-01T04:15:50.864Z (about 1 year ago)
• Language: PureScript
• Homepage:
• Size: 41 KB
• Stars: 7
• Watchers: 5
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ArrayBuffer Types

[![CI](https://github.com/purescript-contrib/purescript-arraybuffer-types/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-arraybuffer-types/actions?query=workflow%3ACI+branch%3Amain)

[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-arraybuffer-types.svg)](https://github.com/purescript-contrib/purescript-arraybuffer-types/releases)

[![Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer-types/badge)](https://pursuit.purescript.org/packages/purescript-arraybuffer-types)

[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](https://github.com/garyb)

Type definitions for JavaScript `ArrayBuffer`s.

## Installation

Install `arraybuffer-types` with [Spago](https://github.com/purescript/spago):

```sh

spago install arraybuffer-types

```

## Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library.

## Documentation

`arraybuffer-types` documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer-types).

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

- [Open an issue](https://github.com/purescript-contrib/purescript-arraybuffer-types/issues) if you have encountered a bug or problem.

- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.

## Contributing

You can contribute to `arraybuffer-types` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-arraybuffer-types/issues). 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](./CONTRIBUTING.md). 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](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.