Type Alias SpanBuilder

Span builder type.

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

Index

Properties

beats hide infinity measures notes

Properties

beats

beats: (beatCount: number) => SpanBuilder

Increase span length by number of beats.

Type Declaration

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

hide

hide: () => SpanBuilder

Create an invisible span.

Type Declaration

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

infinity

infinity: () => SpanBuilder

Create span as long as possible.

Type Declaration

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

measures

measures: (measureCount: number) => SpanBuilder

Increase span length by given number of measures.

Type Declaration

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

notes

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

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

Type Declaration

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