Type Alias ExtensionBuilder

Etension builder type.

type ExtensionBuilder = {
    beats: (beatCount: number) => ExtensionBuilder;
    hide: () => ExtensionBuilder;
    infinity: () => ExtensionBuilder;
    measures: (measureCount: number) => ExtensionBuilder;
    notes: (
        noteLength: NoteLengthValue,
        noteCount?: number,
    ) => ExtensionBuilder;
}

Index

Properties

beats hide infinity measures notes

Properties

beats

beats: (beatCount: number) => ExtensionBuilder

Increase span length by number of beats.

Type Declaration

- (beatCount: number): ExtensionBuilder
- Parameters
  - beatCount: number
    Number of beats.
  Returns ExtensionBuilder
  - this extension builder object.

hide

hide: () => ExtensionBuilder

Create an invisible extension.

Type Declaration

- (): ExtensionBuilder
- Returns ExtensionBuilder
  - this extension builder object.

infinity

infinity: () => ExtensionBuilder

Create as long extension line as possible.

Type Declaration

- (): ExtensionBuilder
- Returns ExtensionBuilder
  - this extension builder object.

measures

measures: (measureCount: number) => ExtensionBuilder

Increase length of extension length by given number of measures.

Type Declaration

- (measureCount: number): ExtensionBuilder
- Parameters
  - measureCount: number
    Number of measures.
  Returns ExtensionBuilder
  - this extension builder object.

notes

notes: (noteLength: NoteLengthValue, noteCount?: number) => ExtensionBuilder

Increase extension length by note length multiplied by number of notes.

Type Declaration

- (noteLength: NoteLengthValue, noteCount?: number): ExtensionBuilder
- Parameters
  - noteLength: NoteLengthValue
    Length of note (e.g. "2n").
  - OptionalnoteCount: number
    Number of note lengths (default = 1).
  Returns ExtensionBuilder
  - this extension builder object.