Options
All
  • Public
  • Public/Protected
  • All
Menu

beepody

beepody

Beep melody utilities for JavaScript.

NPM Version NPM Downloads Build Status Build Size Code Coverage Scrutinizer Code Quality Language Grade GPL 3.0

Demo

CodePen Demo

Install

yarn add beepody

Usage

Build System

import {Beep} from 'beepody'

// Each line is space separated: frequency (Hz), length (ms), repeats
// Default values: "440 200 1"
const beep = new Beep(`
392 250 4
466.2 250
261.6 250
392 250 4
349.2 250
370 250
392 250
10 500
392 250
392 500
392 250 2
466.2 250
261.6 250
392 250 4
349.2 250
370 250
392 500
10 500
`)

beep.play()

Node

const {Beep} = require('beepody')
const beep = new Beep('play 600 988 1 1319 4')
beep.toBeepCommand

Script Tags

<script src="https://unpkg.com/beepody"></script>
<button onClick="beepody.playDefaultBeep()">beep</button>

Command Line Interface

$ beepody "392 250 4"
(beeps?)

$ beepody
beepody> 392 250 4
(beeps?)

CLI in Browser

RunKit

Read the Docs

Documentation

CLI Commands

  • yarn install: Install dependencies
  • yarn dev: Run tests when source files are changed
  • yarn lint --fix: Lint with ESLint
  • yarn test: Run Jest tests
  • yarn doc: Build documentation
  • yarn build: Production build
  • yarn prepublish: Prepare for publishing
  • yarn publish: Publish to npm

Feedback

Sponsorship

Generated using TypeDoc