Merge branch 'main' into pump

packages/core/controls.mjs

@@ -320,6 +320,7 @@ export const { fft } = registerControl('fft');
  *
  * @name decay
  * @param {number | Pattern} time decay time in seconds
+ * @synonyms dec
  * @example
  * note("c3 e3 f3 g3").decay("<.1 .2 .3 .4>").sustain(0)
  *

packages/core/pattern.mjs

@@ -1569,7 +1569,7 @@ export const func = curry((a, b) => reify(b).func(a));
 /**
  * Registers a new pattern method. The method is added to the Pattern class + the standalone function is returned from register.
  *
- * @param {string} name name of the function
+ * @param {string | string[]} name name of the function, or an array of names to be used as synonyms
  * @param {function} func function with 1 or more params, where last is the current pattern
  * @noAutocomplete
  *

packages/tonal/tonal.mjs

@@ -88,13 +88,14 @@ function scaleOffset(scale, offset, note) {
  * @returns Pattern
  * @memberof Pattern
  * @name transpose
+ * @synonyms trans
  * @example
  * "c2 c3".fast(2).transpose("<0 -2 5 3>".slow(2)).note()
  * @example
  * "c2 c3".fast(2).transpose("<1P -2M 4P 3m>".slow(2)).note()
  */
 
-export const transpose = register('transpose', function (intervalOrSemitones, pat) {
+export const transpose = register(['transpose', 'trans'], function transposeFn(intervalOrSemitones, pat) {
   return pat.withHap((hap) => {
     const note = hap.value.note ?? hap.value;
     if (typeof note === 'number') {
@@ -142,6 +143,7 @@ export const transpose = register('transpose', function (intervalOrSemitones, pa
  * @name scaleTranspose
  * @param {offset} offset number of steps inside the scale
  * @returns Pattern
+ * @synonyms scaleTrans, strans
  * @example
  * "-8 [2,4,6]"
  * .scale('C4 bebop major')
@@ -149,22 +151,25 @@ export const transpose = register('transpose', function (intervalOrSemitones, pa
  * .note()
  */
 
-export const scaleTranspose = register('scaleTranspose', function (offset /* : number | string */, pat) {
-  return pat.withHap((hap) => {
-    if (!hap.context.scale) {
-      throw new Error('can only use scaleTranspose after .scale');
-    }
-    if (typeof hap.value === 'object')
-      return hap.withValue(() => ({
-        ...hap.value,
-        note: scaleOffset(hap.context.scale, Number(offset), hap.value.note),
-      }));
-    if (typeof hap.value !== 'string') {
-      throw new Error('can only use scaleTranspose with notes');
-    }
-    return hap.withValue(() => scaleOffset(hap.context.scale, Number(offset), hap.value));
-  });
-});
+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');
+      }
+      if (typeof hap.value === 'object')
+        return hap.withValue(() => ({
+          ...hap.value,
+          note: scaleOffset(hap.context.scale, Number(offset), hap.value.note),
+        }));
+      if (typeof hap.value !== 'string') {
+        throw new Error('can only use scaleTranspose with notes');
+      }
+      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}.