Type Alias TransposingInstrument

TransposingInstrument:
    | TransposingInstrumentName
    | string & {}
    | Exclude<IntervalLike, string>

A transposing instrument: one of the built-in names, or a spelled interval for an instrument the table does not carry.

An interval is read in the same written-to-sounding direction as the table, so '-M2' is any instrument in B flat and 'P8' any that sounds an octave up. The names complete in an editor while any other string is still accepted, which is what lets an instrument read from configuration go straight in.

Example

import type { TransposingInstrument } from '@libraz/libcantus';
const clarinet: TransposingInstrument = 'clarinetA';
const altoFlute: TransposingInstrument = '-P4';

Type Alias TransposingInstrument

Example

Settings