0.2.1 • Published 6 years ago
guitarics-chordify v0.2.1
guitarics-chordify
Features
- Create and transpose music chords.
Usage
const chordify = require('guitarics-chordify');
const chord = new chordify.Chord('Bsus4');
console.log(chord); // Chord { note: 'B', key: 'B', variation: 'sus4', isSharpKey: true }
chord.flatten();
console.log(chord); // Chord { note: 'Bb', key: 'Bb', variation: 'sus4', isSharpKey: false }
chord.sharpen(); // Return back to original chord Bsus4
chord.sharpen();
chord.getChord(); // Csus4
Add chord with key
const chordify = require('guitarics-chordify');
// A Bsus4 chord for a song in the key of E
const chord = new chordify.Chord('Bsus4', 'E');
// Chord { note: 'B', key: 'E', variation: 'sus4', isSharpKey: true }
Install
npm install --save guitarics-chordify
Scripts
- npm run build :
tsc
- npm run test :
mocha ./dist/test/*.js
Dependencies
Package | Version | Dev |
---|---|---|
@types/chai | ^4.1.3 | ✔ |
@types/mocha | ^5.2.0 | ✔ |
chai | ^4.1.2 | ✔ |
mocha | ^5.1.1 | ✔ |
ts-node | ^6.0.0 | ✔ |
Contributing
Contributions welcome; Please submit all pull requests against the master branch. If your pull request contains JavaScript patches or features, you should include relevant unit tests. Please check the Contributing Guidelines for more details. Thanks!
Author
Wendly Saintil wendlysaintil@gmail.com https://twitter.com/wendlysaintil