Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slurmulon/tonal-index
:books: Music theory library providing iterable collections of every possible note, scale and chord
https://github.com/slurmulon/tonal-index
chords index music-theory notes scales tonal
Last synced: 10 days ago
JSON representation
:books: Music theory library providing iterable collections of every possible note, scale and chord
- Host: GitHub
- URL: https://github.com/slurmulon/tonal-index
- Owner: slurmulon
- License: mit
- Created: 2018-03-23T05:36:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-29T05:50:54.000Z (about 6 years ago)
- Last Synced: 2024-10-19T10:08:53.839Z (20 days ago)
- Topics: chords, index, music-theory, notes, scales, tonal
- Language: JavaScript
- Homepage:
- Size: 154 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tonal-index
> :books: Music theory library providing iterable collections of every possible note, scale and chord
---
If you have ever needed to iterate through every possible note, scale, or chord in your music applications then `tonal-index` is the answer.
`tonal-index` uses [`tonal`](https://npmjs.com/tonal) to dynamically generate and aggregate each collection.
## Modes
Because `tonal-index` generates relatively large sets of data it may be loaded in either warm or lazy mode.
- **Warm**: Pre-generates and caches all of the possible collection values
- **Lazy**: Defers generation until the collections are actually needed (default)
## Install
`npm install --save tonal-index`
then, either:
```js
// warm / pre-cached module
const music = require('tonal-index')()
```
or
```js
// lazy module
const music = require('tonal-index')
```
## API
### `all`
- **Types**: `notes`, `scales`, and `chords`
- **Returns**: Every possible combination of `notes`, `scales`, or `chords`
```js
const { notes, scales, chord } = require('tonal-index')
notes.all() // [ 'C', 'C#', 'Db', 'D', 'D#', 'Eb', ...]
scales.all() // 1530 results
chords.all() // 1853 results
```
### `by`
Queries `scale` or `chord` collections by either `type` or `root`.
- **Types**: `scales`, `chords`
- **Params**:
* `key`: Either `'type'` or `'root'` (i.e. the root `note` of the `scale` or `chord`)
* `value`: The value to compare all other values against
- **Returns**: Entire collection filtered by entries matching a `key` and `value`
```js
const { scales, chords } = require('tonal-index')
const majScales = scales.by('type', 'major')
const min7Chords = chords.by('type', 'm7')
```
### `each`
- **Types**: `scales`, `chords`
- **Returns**: Each combination of `scales`, or `chords`, one element at a time (generator)
```js
const { scales } = require('tonal-index')
const generate = scales.each()
generate.next()
```
### Output
You can find the full list of chords and scales in [`test/fixtures/*`](https://github.com/slurmulon/tonal-index/tree/master/test/fixtures)
## Types
### `note`
- Type: `string`
- Format: [Scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation)
### `scale` and `chord`
- Type: `object`
- Properties:
- `type`:
- Type: `string`
- Format: [Scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation)
- Examples: `"+add#9"`, `"m7"`, `"major"`
- `root`:
- Type: `string`
- Format: [Scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation)
- Example: `"C"`
- `notes`:
- Type: `Array`
- Format: [Scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation)
- Example: `["C", "E", "G#", "D#"]`
## Future
- [ ] Optionally group by root note
- [ ] Configurable octaves
- [ ] Chord voicings
- [ ] Chord inversions
- [x] Generator collection
## License
MIT