Fix export for frequencies tool

Author: peterkhayes

README.md

@@ -1,22 +1,28 @@
 [![Build Status](https://travis-ci.org/peterkhayes/pitchfinder.svg?branch=master)](https://travis-ci.org/peterkhayes/pitchfinder)
+
 # pitchfinder
+
 A compilation of pitch detection algorithms for Javascript. Supports both the browser and node.
 
 ## Provided pitch-finding algorithms
-- **YIN** - The best balance of accuracy and speed, in my experience.  Occasionally provides values that are wildly incorrect.
+
+- **YIN** - The best balance of accuracy and speed, in my experience. Occasionally provides values that are wildly incorrect.
 - **AMDF** - Slow and only accurate to around +/- 2%, but finds a frequency more consistenly than others.
 - **Dynamic Wavelet** - Very fast, but struggles to identify lower frequencies.
-- **YIN w/ FFT** *(coming soon)*
-- **Goertzel** *(coming soon)*
-- **Mcleod** *(coming soon)*
+- **YIN w/ FFT** _(coming soon)_
+- **Goertzel** _(coming soon)_
+- **Mcleod** _(coming soon)_
 
 ## Installation
+
 `npm install --save pitchfinder`
 
 ## Usage
 
 ### Finding the pitch of a wav file in node
+
 All pitchfinding algorithms provided operate on `Float32Array`s. To find the pitch of a `wav` file, we can use the `wav-decoder` library to extract the data into such an array.
+
 ```javascript
 const fs = require("fs");
 const WavDecoder = require("wav-decoder");
@@ -32,17 +38,21 @@ const pitch = detectPitch(float32Array); // null if pitch cannot be identified
 ```
 
 ### Finding the pitch of a WebAudio AudioBuffer in the browser
-This assumes you are using an npm-compatible build system, like Webpack or Browserify, and that your target browser supports WebAudio.  Ample documentation on WebAudio is available online, especially on Mozilla's MDN.
+
+This assumes you are using an npm-compatible build system, like Webpack or Browserify, and that your target browser supports WebAudio. Ample documentation on WebAudio is available online, especially on Mozilla's MDN.
+
 ```javascript
-const Pitchfinder = require("pitchfinder");
-const detectPitch = Pitchfinder.AMDF();
+import * as Pitchfinder from "pitchfinder";
 
 const myAudioBuffer = getAudioBuffer(); // assume this returns a WebAudio AudioBuffer object
 const float32Array = myAudioBuffer.getChannelData(0); // get a single channel of sound
+
+const detectPitch = Pitchfinder.AMDF();
 const pitch = detectPitch(float32Array); // null if pitch cannot be identified
 ```
 
 ### Finding a series of pitches
+
 Set a tempo and a quantization interval, and an array of pitches at each interval will be returned.
 
 ```javascript
@@ -56,41 +66,50 @@ const frequencies = Pitchfinder.frequencies(detectPitch, float32Array, {
 
 // or use multiple detectors for better accuracy at the cost of speed.
 const detectors = [detectPitch, Pitchfinder.AMDF()];
-const moreAccurateFrequencies = Pitchfinder.frequencies(detectors, float32Array, {
-  tempo: 130, // in BPM, defaults to 120
-  quantization: 4, // samples per beat, defaults to 4 (i.e. 16th notes)
-});
+const moreAccurateFrequencies = Pitchfinder.frequencies(
+  detectors,
+  float32Array,
+  {
+    tempo: 130, // in BPM, defaults to 120
+    quantization: 4, // samples per beat, defaults to 4 (i.e. 16th notes)
+  }
+);
 ```
 
-
 ## Configuration
 
 ### All detectors
+
 - `sampleRate` - defaults to 44100
 
 ### YIN
+
 - `threshold` - used by the algorithm
 - `probabilityThreshold` - don't return a pitch if probability estimate is below this number.
 
 ### AMDF
+
 - `minFrequency` - Lowest frequency detectable
 - `maxFrequency` - Highest frequency detectable
 - `sensitivity`
 - `ratio`
 
 ### Dynamic Wavelet
-*no special config*
+
+_no special config_
 
 ## Note
 
 If you'd like a version that uses compiled C++ code and runs much faster, check out [this repo](https://github.com/cristovao-trevisan/node-pitchfinder). However, it will not work in the browser.
 
 ## Todo
+
 - Integrate with `teoria` or another music theory tool to add more intelligent parsing.
-- Note-onsite algorithms.
+- Note-onset algorithms.
 - Enable requiring of single detectors.
 
 ## Thanks
-Several of these algorithms were ported from Jonas Six's excellent TarsosDSP library (written in Java).  If you're looking for a far deeper set of tools than this, check out his work [on his website](https://0110.be/tags/TarsosDSP) or [on Github](https://github.com/JorenSix/TarsosDSP).
+
+Several of these algorithms were ported from Jonas Six's excellent TarsosDSP library (written in Java). If you're looking for a far deeper set of tools than this, check out his work [on his website](https://0110.be/tags/TarsosDSP) or [on Github](https://github.com/JorenSix/TarsosDSP).
 
 Thanks to Aubio for his [YIN code](https://github.com/aubio/aubio/blob/master/src/pitch/pitchyin.c)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pitchfinder",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "A pitch-detection library for node and the browser",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -50,4 +50,4 @@
     "wav": "^1.0.0",
     "wav-decoder": "^1.1.0"
   }
-}
+}

src/index.ts

@@ -17,6 +17,7 @@ export {
   DynamicWaveletConfig,
   Macleod,
   MacleodConfig,
+  frequencies,
 };
 
 export default {