sm.builderGuide
Associated object type: BuilderGuide
Builder Guide
Functions:
sm.builderGuide.createBuilderGuide(path, shape, ignoreBlockUuid?, recordErrors?, allowExtraBlocks?)
Create a BuilderGuide, comparing the creation from the root Shape to the blueprint given by the path.
Parameters:
| Type | Name | Description |
|---|---|---|
| string | path | A file path to the builder guide blueprint. |
| Shape | shape | Root Shape for comparing the creation from. |
| boolean | ignoreBlockUuid? | Should block uuid be ignored for stage completion. (Defaults to false) |
| boolean | recordErrors? | Should errors be recorded. Needed for getErrorInfo (Defaults to false) |
| boolean | allowExtraBlocks? | Should extra blocks be ignored for stage completion. (Defaults to true) |
Returns:
| Type | Description |
|---|---|
| BuilderGuide | The created guide. |