hacklab/strudel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add docstring and example

Browse source
This commit is contained in:
Aria 2026-01-22 14:08:26 -06:00
parent 6e61f3cdb6
commit d79d122f68
3 changed files with 45 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
packages/core/pattern.mjs
View file

@ -1256,6 +1256,20 @@ const ALIGNMENT_KEYS = ALIGNMENTS.map((how) => how.toLowerCase());
};
})();
/**
* Sets the default [alignment](https://strudel.cc/technical-manual/alignment/) to be used by Strudel.
* The default default alignment is `in`, meaning that patterns to the left will (typically) dictate
* the event timings when combined with patterns to the right. By changing alignment to `out`, the opposite
* will happen. With `mix`, they will combine their event timings.
*
* Note that we say the _default_ alignment, because alignments can also be set explicitly with calls like
* `add.mix`, `set.squeeze`, etc.
*
* @param {string} name Default alignment to use. Options: 'in', 'out', 'mix', 'squeeze', 'squeezeout', 'reset', 'restart', 'poly'
* @example
* setDefaultAlignment('mix') // also try 'in', 'out', 'squeeze', etc.
* s("saw").vel("1 0.5").note("F A C E").delay("0 0.2 0.3")
*/
export const setDefaultAlignment = (alignment) => {
alignment = alignment?.toLowerCase();
if (DEFAULT_ALIGNMENT !== alignment && ALIGNMENT_KEYS.includes(alignment)) {