validate-note
🎼 Validates a note (scientific pitch notation) and throws errors if needed
Usage
; const note = ;console; // > { letter: 'A', signature: '#', octave: 4 }
Installation
Install via yarn
yarn add validate-note (--dev)
or npm
npm install validate-note (--save-dev)
configuration
You can pass in extra options (➕ required, ➖ optional, ✏️ default)
; const note = ; console; // > { letter: 'A', signature: '#', octave: 4 }
➖ maxOctave ( Number ) ✏️ 8
📝 max octave allowed
➖ flatToSharp ( Boolean ) ✏️ false
📝 convert flats (b) to sharps (#)
➖ octave ( Boolean ) ✏️ false
📝 octave is required
ℹ️ A#
throws error, A#3
is a valid note
Builds
If you don't use a package manager, you can access validate-note
via unpkg (CDN), download the source, or point your package manager to the url.
validate-note
is compiled as a collection of CommonJS modules & ES2015 modules for bundlers that support the jsnext:main
or module
field in package.json (Rollup, Webpack 2)
The validate-note
package includes precompiled production and development UMD builds in the dist
folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a <script>
tag on your page. The UMD builds make validate-note
available as a window.validateNote
global variable.
License
The code is available under the MIT license.
Contributing
We are open to contributions, see CONTRIBUTING.md for more info.
Misc
This module was created using generator-module-boilerplate.