https://github.com/edgarogh/quietjs-bundle

A utility to bundle quiet-js in one file
https://github.com/edgarogh/quietjs-bundle

communication data-transfer home-automation npm npm-module npm-package quiet-js sound transfer typescript ultrasonic webaudio

Last synced: 11 days ago
JSON representation

A utility to bundle quiet-js in one file

• Host: GitHub
• URL: https://github.com/edgarogh/quietjs-bundle
• Owner: edgarogh
• License: mit
• Created: 2019-05-01T12:55:39.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T00:20:01.000Z (8 months ago)
• Last Synced: 2024-10-09T11:04:47.549Z (29 days ago)
• Topics: communication, data-transfer, home-automation, npm, npm-module, npm-package, quiet-js, sound, transfer, typescript, ultrasonic, webaudio
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/quietjs-bundle
• Size: 585 KB
• Stars: 8
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [**quietjs-bundle**](https://www.npmjs.com/package/quietjs-bundle)

[![License: MIT](https://img.shields.io/npm/l/quietjs-bundle)](https://github.com/edgarogh/quietjs-bundle/blob/master/LICENSE)

[![NPM latests version](https://img.shields.io/npm/v/quietjs-bundle)](https://www.npmjs.com/package/quietjs-bundle)

[![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/quietjs-bundle)](https://github.com/edgarogh/quietjs-bundle/blob/master/package.json)

> quietjs-bundle is a ready-to-use bundled version of [quiet-js](https://github.com/quiet/quiet-js) that you can require in CommonJS/TypeScript-based web projects

> ```javascript

> const quiet = require('quietjs-bundle');

> 

> quiet.addReadyCallback(() => {

>    quiet.receiver({ profile: 'ultrasonic-experimental', onReceive: console.log });

> });

> ```

## Motivations

I needed to use [quiet-js](https://github.com/quiet/quiet-js) in a project, and was annoyed by the fact that I needed to serve many dependencies for the library to work and couldn't bundle everything in one file with a tool like [ParcelJS](https://parceljs.org/). I made this bundler, which automatically downloads all the required files from the latest version of quiet-js from its GitHub repository and combines the files together.

## Features

 * Bundles `quiet-emscripten.js.mem` (a binary file) using base64

 * Initializes the library as soon as the bundle is loaded on the webpage

 * Allows the whole code to be wrapped in an [IIFE](https://developer.mozilla.org/en-US/docs/Glossary/IIFE), so the global scope isn't polluted

 * Includes TypeScript definitions

## Installation

```bash

npm i quietjs-bundle

```

Installing the module will build the bundle a first time. If you want to rebuild it, navigate to `node_modules/quietjs-bundle` in your shell and run `npm run-script bundle`.

## TODO

  * [ ] More size-efficient `quiet-emscripten.js.mem` bundling (currently stored as a string literal using base64)

  * [x] Download specific `quiet-js` commit instead of latest for stability

  * [x] Document the TypeScript definitions

## License

This project itself is licensed under the MIT license. However, this tool bundles code from different sources that each have their own license. You are entirely responsible for every bit of licensed code that can end up in the final script.

Since the whole downloading & building/bundling process involving externally licensed code happens on your computer, I don't think that I have to specify the license of each piece of code. After all, this project is just a _tool_ that does all the magic™. However, I'm not a lawyer, and if the previous statement is wrong, get in touch with me so I fix this !