doc: iterBack

This commit is contained in:
Felix Roos 2022-09-19 23:21:55 +02:00
parent abe28367fb
commit e4f4fe81ae
2 changed files with 10 additions and 3 deletions

View File

@ -1170,8 +1170,6 @@ export class Pattern {
* @name iter * @name iter
* @memberof Pattern * @memberof Pattern
* @returns Pattern * @returns Pattern
* @param {number} divide number of subdivisions
* @param {boolean} back if true, iterate backwards
* @example * @example
* note("0 1 2 3".scale('A minor')).iter(4).out() * note("0 1 2 3".scale('A minor')).iter(4).out()
*/ */
@ -1179,7 +1177,14 @@ export class Pattern {
return slowcat(...listRange(0, times - 1).map((i) => (back ? this.late(i / times) : this.early(i / times)))); return slowcat(...listRange(0, times - 1).map((i) => (back ? this.late(i / times) : this.early(i / times))));
} }
// known as iter' in tidalcycles /**
* Like `iter`, but plays the subdivisions in reverse order. Known as iter' in tidalcycles
* @name iterBack
* @memberof Pattern
* @returns Pattern
* @example
* note("0 1 2 3".scale('A minor')).iterBack(4).out()
*/
iterBack(times) { iterBack(times) {
return this.iter(times, true); return this.iter(times, true);
} }

View File

@ -504,6 +504,8 @@ The following functions modify a pattern temporal structure in some way.
{{ 'Pattern.iter' | jsdoc }} {{ 'Pattern.iter' | jsdoc }}
{{ 'Pattern.iterBack' | jsdoc }}
## Conditional Modifiers ## Conditional Modifiers
{{ 'Pattern.every' | jsdoc }} {{ 'Pattern.every' | jsdoc }}