https://github.com/danigb/tonal.transpose

Music note transposition
https://github.com/danigb/tonal.transpose

Last synced: 13 days ago
JSON representation

Music note transposition

• Host: GitHub
• URL: https://github.com/danigb/tonal.transpose
• Owner: danigb
• License: mit
• Created: 2015-11-23T19:00:35.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-01T21:21:11.000Z (almost 9 years ago)
• Last Synced: 2023-04-11T13:58:29.470Z (over 1 year ago)
• Language: HTML
• Homepage:
• Size: 77.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# tonal.transpose

[![Build Status](https://travis-ci.org/danigb/tonal.svg?branch=master)](https://travis-ci.org/danigb/tonal.transpose)

[![Code Climate](https://codeclimate.com/github/danigb/tonal.transpose/badges/gpa.svg)](https://codeclimate.com/github/danigb/tonal.transpose)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

[![npm version](https://img.shields.io/npm/v/tonal.transpose.svg)](https://www.npmjs.com/package/tonal.transpose)

[![license](https://img.shields.io/npm/l/tonal.transpose.svg)](https://www.npmjs.com/package/tonal.transpose)

[![tonal](https://img.shields.io/badge/tonal-transpose-yellow.svg)](https://www.npmjs.com/package/tonal)

`tonal.transpose` is a [compact](https://rawgit.com/danigb/tonal.transpose/master/dist/disc.html) function to transpose notes:

```js

var transpose = require('tonal.transpose')

transpose('C3', '3m') // => 'Eb3'

```

It's part of [tonal](https://www.npmjs.com/package/tonal)

## Install

Via npm: `npm i --save tonal.transpose` and require the function. Use browserify or webpack to create a browser ready distribution.

Or use the [distribution file](https://raw.githubusercontent.com/danigb/tonal.transpose/master/dist/tonal.transpose.min.js) (adds `transpose` function to window globals):

```html

console.log(transpose('C3', '3m'))

```

## Usage

#### Note transposition

The simplest usage is with a note name (pitch) and interval (the order doesn't matter):

```js

transpose('C2', '4A') // => 'F#2'

transpose('4A', 'C2') // => 'F#2'

```

#### Pitch class transposition

You can transpose pitch classes (note names without octaves), and the returned value will be a pitch class:

```js

tranpose('A', '3M') // => 'C#'

tranpose('A5', '3M') // => 'C#5'

```

#### Add intervals

If you need it you can transpose an interval:

```js

transpose('3M', '3M') // => '5A'

```

#### Transposers

Also, you can partially apply the function to get a transposer:

```js

var major3th = transpose('3M')

major3th('D') // => 'F#'

```

#### Map arrays

Partially applied transposers allows to work with arrays seamlessly:

```js

['C', 'D', 'E', 'F', 'G'].map(transpose('3M')) // => ['E', 'F#', 'G#', 'A', 'B']

['1P', '3m', '5P'].map(transpose('C')) // => ['C', 'Eb', 'G']

```

#### More...

See [tonal](https://www.npmjs.com/package/tonal)

## License

MIT License