Builder | rockplate

Type parameters

T

Hierarchy

Builder

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Builder(code: string, schemaResolver?: T | SchemaResolver<T>, strictOverride?: undefined | false | true): Builder

- Defined in Builder.ts:16
Parameters
- code: string
- Optional schemaResolver: T | SchemaResolver<T>
- Optional strictOverride: undefined | false | true
Returns Builder

Properties

Private Optional builtBlocks

builtBlocks: Block[]

code

code: string

Optional schema

schema: T

Private Optional schemaResolver

schemaResolver: T | SchemaResolver<T>

Private Optional strictOverride

strictOverride: undefined | false | true

template

template: string

Accessors

blocks

get blocks(): Block[]

- Defined in Builder.ts:38
Returns Block[]

strict

get strict(): boolean

- Defined in Builder.ts:26
Returns boolean

type

get type(): "strict" | "dynamic"

- Defined in Builder.ts:34
Returns "strict" | "dynamic"

Methods

Private advanceOffset

advanceOffset(block: LiteralBlock | CommentBlock, offset: number): number

- Defined in Builder.ts:487
Parameters
- block: LiteralBlock | CommentBlock
- offset: number
Returns number

build

build(): Promise<Block[]>

- Defined in Builder.ts:46
Returns Promise<Block[]>

Private findFirstBlock

findFirstBlock(tpl: string, schema: any): Block | undefined

- Defined in Builder.ts:275
Parameters
- tpl: string
- schema: any
Returns Block | undefined

Private findNextBlock

findNextBlock(tpl: string, schema: any, block: Block): undefined | Block

- Defined in Builder.ts:310
Parameters
- tpl: string
- schema: any
- block: Block
Returns undefined | Block

Private findOuterBlocks

findOuterBlocks(tpl: string, schema: any): Block[]

- Defined in Builder.ts:113
Parameters
- tpl: string
- schema: any
Returns Block[]

Private findOuterBlocksRecursively

findOuterBlocksRecursively(tpl: string, schema: any): Block[]

- Defined in Builder.ts:151
Parameters
- tpl: string
- schema: any
Returns Block[]

Private getBlock

getBlock(tpl: string, schema: any, idx: number, blockType: BlockType, expression: string, end: string, key?: undefined | string, subkey?: undefined | string, operator?: undefined | string): undefined | Block

- Defined in Builder.ts:395
Parameters
- tpl: string
- schema: any
- idx: number
- blockType: BlockType
- expression: string
- end: string
- Optional key: undefined | string
- Optional subkey: undefined | string
- Optional operator: undefined | string
Returns undefined | Block

getBlockAt

getBlockAt(index: number): Block | undefined

- Defined in Builder.ts:536
Parameters
- index: number
Returns Block | undefined

Private getBlockAtIndex

getBlockAtIndex(blocks: Block[], index: number): Block | undefined

- Defined in Builder.ts:516
Parameters
- blocks: Block[]
- index: number
Returns Block | undefined

Protected getBlockPrefix

getBlockPrefix(blockType: BlockType): string

- Defined in Builder.ts:168
Parameters
- blockType: BlockType
Returns string

Private getCommentBlock

getCommentBlock(tpl: string, idx: number): undefined | Block

- Defined in Builder.ts:465
Parameters
- tpl: string
- idx: number
Returns undefined | Block

getDynamicBlockDefinition

getDynamicBlockDefinition(idx: number, blockType: BlockType, tpl: string): BlockDefinition | undefined

- Defined in Builder.ts:178
Parameters
- idx: number
- blockType: BlockType
- tpl: string
Returns BlockDefinition | undefined

getIdentifiers

getIdentifiers(schema: any): { key: string; subkey: string }[]

- Defined in Builder.ts:324
Parameters
- schema: any
Returns { key: string; subkey: string }[]

Private getIfBlock

getIfBlock(tpl: string, schema: any, operator: string, key: string, subkey: string, idx: number): undefined | Block

- Defined in Builder.ts:473
Parameters
- tpl: string
- schema: any
- operator: string
- key: string
- subkey: string
- idx: number
Returns undefined | Block

Private getLiteralBlock

getLiteralBlock(tpl: string, schema: any, prevBlock?: Block, nextBlock?: Block): Block

- Defined in Builder.ts:363
Parameters
- tpl: string
- schema: any
- Optional prevBlock: Block
- Optional nextBlock: Block
Returns Block

Private getParamsMergedForBlock

getParamsMergedForBlock(block: Block, params: any, childParams?: any): any

- Defined in Builder.ts:87
Parameters
- block: Block
- params: any
- Optional childParams: any
Returns any

Private getRepeatBlock

getRepeatBlock(tpl: string, schema: any, key: string, idx: number): undefined | Block

- Defined in Builder.ts:469
Parameters
- tpl: string
- schema: any
- key: string
- idx: number
Returns undefined | Block

Private getSchemaFromString

getSchemaFromString(str: string): undefined | false | { endIndex: number; offset: number; schema: any; startIndex: number }

- Defined in Builder.ts:91
Parameters
- str: string
Returns undefined | false | { endIndex: number; offset: number; schema: any; startIndex: number }

Private getStrictBlockDefinition

getStrictBlockDefinition(idx: number, blockType: BlockType, tpl: string, schema: any): BlockDefinition | undefined

- Defined in Builder.ts:213
Parameters
- idx: number
- blockType: BlockType
- tpl: string
- schema: any
Returns BlockDefinition | undefined

getValidBlockDefinition

getValidBlockDefinition(idx: number, blockType: BlockType, tpl: string, schema: any): BlockDefinition | undefined

- Defined in Builder.ts:258
Parameters
- idx: number
- blockType: BlockType
- tpl: string
- schema: any
Returns BlockDefinition | undefined

getVariables

getVariables(schema: any): { key: string; subkey: string; type: "identifier" | "boolean" | "array" }[]

- Defined in Builder.ts:332
Parameters
- schema: any
Returns { key: string; subkey: string; type: "identifier" | "boolean" | "array" }[]

isValidIdentifier

isValidIdentifier(identifiers: { key: string; subkey: string }[], identifier: string): boolean

- Defined in Builder.ts:320
Parameters
- identifiers: { key: string; subkey: string }[]
- identifier: string
Returns boolean

Private repairOffsets

repairOffsets(blocks: Block[], outerOffset: number): number

- Defined in Builder.ts:491
Parameters
- blocks: Block[]
- outerOffset: number
Returns number

Generated using TypeDoc