@musical-patterns/spec v1.0.52

Musical Patterns - Spec

interface Spec<SpecsType extends Specs = Specs> {
    computeValidations?: ComputeValidations<SpecsType>,
    configurations: Configurations<SpecsType>,
    initialSpecs: SpecsType,
    presets?: ObjectOf<Preset<SpecsType>>,
}

Spec is the name for this data structure which is attached to Pattern. In this context it is used in the conceptual singular sense. An individual "spec" is one property which controls the materials for the pattern. A value for one of these properties is typed as a SpecValue, and key is currently just a string but may one day be a nominally-typed string called a SpecKey The object containing such specs is typed as Specs. The Pattern type is generic, and takes a type of Specs as its single parameter, which is then passed to the pattern's Spec property.

• initialSpecs is what the compiler from @musical-patterns/material will use as your pattern's Specs when materializing your pattern if you do not specifically provide a Specs object.
• presets is an object containing Specs that your pattern could materialize with. Use presets when there are a few particular combinations of spec settings you'd like to highlight and make easily accessible.
• configurations are again mapped to your Pattern's SpecsType argument, and each Configuration determines how the control for that spec will work. - inputType is either ranged (numeric), optioned (set of strings), toggled (boolean), or stringed (an arbitary string, almost certainly heavily custom validated). - isArrayed, when true, indicates that your spec is actually an array of values of the above type. @musical-patterns/playroom provides add and remove buttons for changing the length. These control elements are called fields. - arrayedNewFieldInitialValue so you can make new fields start out with a defined value rather than empty. - hideInput is used only for the ranged inputType, which has two types of inputs, one text-based, one a slider. By default, each field contains both input types, but you can hide one or the other. - constraint differs by inputType. Any time spec is submitted, it is first checked against these constraints before attempting to compile. - Ranged inputs have min/max, step sizes, and can be constrained to integers. - Optioned inputs - this is where you provide the set of options. - Toggled inputs - no constraint, as these are simple booleans. - Stringed inputs - min/max length in chars.
• computeValidations is a function that will get called by the @musical-patterns/playroom whenever a potential object of Specs is submitted from the UI. It's necessary whenever the conditions of your Specs' validity involve relationships between multiple specs, or just conditions within a single spec which are more complicated than the basic provided constraints.

There are several standard specs, including base duration and base frequency. Any pattern should be able to use these, but your pattern's specs type is not forced to extend them.

The Presentable interface from the metadata module is extended by several other interfaces in the spec module, including Preset, Configuration, and OptionedConstraintOption. In the case of these spec interfaces, the description property will display to the @musical-patterns/playroom user as hover text.