add synonyms for scaleTranspose

This commit is contained in:
Lu[ke] Wilson 2025-08-02 10:25:28 +01:00
parent cdbbe079db
commit efc2333360

View file

@ -142,6 +142,7 @@ export const transpose = register('transpose', function (intervalOrSemitones, pa
* @name scaleTranspose
* @param {offset} offset number of steps inside the scale
* @returns Pattern
* @synonyms scaleTrans
* @example
* "-8 [2,4,6]"
* .scale('C4 bebop major')
@ -149,7 +150,9 @@ export const transpose = register('transpose', function (intervalOrSemitones, pa
* .note()
*/
export const scaleTranspose = register('scaleTranspose', function (offset /* : number | string */, pat) {
export const scaleTranspose = register(
['scaleTranspose', 'scaleTrans', 'strans'],
function (offset /* : number | string */, pat) {
return pat.withHap((hap) => {
if (!hap.context.scale) {
throw new Error('can only use scaleTranspose after .scale');
@ -164,7 +167,8 @@ export const scaleTranspose = register('scaleTranspose', function (offset /* : n
}
return hap.withValue(() => scaleOffset(hap.context.scale, Number(offset), hap.value));
});
});
},
);
/**
* Turns numbers into notes in the scale (zero indexed). Also sets scale for other scale operations, like {@link Pattern#scaleTranspose}.