Type Alias TupletBuilder

Tuplet builder type.

type TupletBuilder = {
    addChord: (
        notes: (Note | string)[],
        noteLength: NoteLength | NoteLengthStr,
        noteOptions?: NoteOptions,
    ) => TupletBuilder;
    addNote: (
        note: Note | string | (Note | string)[],
        noteLength: NoteLength | NoteLengthStr,
        noteOptions?: NoteOptions,
    ) => TupletBuilder;
    addRest: (
        restLength: NoteLength | NoteLengthStr,
        restOptions?: RestOptions,
    ) => TupletBuilder;
}

Index

Properties

addChord addNote addRest

Properties

addChord

addChord: (
    notes: (Note | string)[],
    noteLength: NoteLength | NoteLengthStr,
    noteOptions?: NoteOptions,
) => TupletBuilder

Add chord to a tuplet.

Type Declaration

- (
      notes: (Note | string)[],
      noteLength: NoteLength | NoteLengthStr,
      noteOptions?: NoteOptions,
  ): TupletBuilder
- Parameters
  - notes: (Note | string)[]
    Array of notes, each instance of Note or string (e.g. "D4").
  - noteLength: NoteLength | NoteLengthStr
    Note length (e.g. "4n").
  - OptionalnoteOptions: NoteOptions
    Note options.
  Returns TupletBuilder
  - This tuplet builder object.

addNote

addNote: (
    note: Note | string | (Note | string)[],
    noteLength: NoteLength | NoteLengthStr,
    noteOptions?: NoteOptions,
) => TupletBuilder

Add note to a tuplet.

Type Declaration

- (
      note: Note | string | (Note | string)[],
      noteLength: NoteLength | NoteLengthStr,
      noteOptions?: NoteOptions,
  ): TupletBuilder
- Parameters
  - note: Note | string | (Note | string)[]
    Instance of Note or string, single value (e.g. "C4") or array (e.g. ["C4", "E4", "G4"]).
  - noteLength: NoteLength | NoteLengthStr
    Note length (e.g. "4n").
  - OptionalnoteOptions: NoteOptions
    Note options.
  Returns TupletBuilder
  - This tuplet builder object.

addRest

addRest: (
restLength: NoteLength | NoteLengthStr,
restOptions?: RestOptions,
) => TupletBuilder

Add rest to a tuplet.

Type Declaration

- (
  restLength: NoteLength | NoteLengthStr,
  restOptions?: RestOptions,
  ): TupletBuilder
- Parameters
  - restLength: NoteLength | NoteLengthStr
    Rest length (e.g. "4n").
  - OptionalrestOptions: RestOptions
    Rest options.
  Returns TupletBuilder
  - This tuplet builder object.