Template

In summary, a

Template describes all components of a solution spanning ingestion, transformation, simulation, optimisation, visualisation and user/system interaction, with respect to data

Classes

ModuleBuilder

Other

DynamicModule

Ƭ DynamicModule: Object

A dynamic namespace for template components, that can be instantiated at runtime

Type declaration

Name	Type
`module`	`ModulePath`
`name`	`string`
`stream`	`Stream`<`DictType`>
`type`	`"dynamic"`

DynamicModulePathComponent

Ƭ DynamicModulePathComponent: Object

A component of the path identifying the location of a module inside a template

Type declaration

Name	Type
`key_type`	`StringType`
`name`	`string`
`type`	`"dynamic"`

Module

Ƭ Module:

StaticModule | DynamicModule

A namespace for template components

ModulePath

Ƭ ModulePath:

ModulePathComponent[]

A path from the template root to a module

ModulePathComponent

Ƭ ModulePathComponent:

StaticModulePathComponent | DynamicModulePathComponent

A component of the path identifying the location of a module

StaticModule

Ƭ StaticModule: Object

A static namespace for template components

Type declaration

Name	Type
`module`	`ModulePath`
`name`	`string`
`type`	`"static"`

StaticModulePathComponent

Ƭ StaticModulePathComponent: Object

A component of the path identifying the location of a module inside a template

Type declaration

Name	Type
`name`	`string`
`type`	`"static"`

checkImport

▸ checkImport(module, from): void

Check if module is visible inside from, otherwise throw an error.

This is true when the module path of from starts with the module path of module, and false otherwise.

Parameters

Name	Type
`module`	`ModulePath`
`from`	`ModulePath`

Returns

void

modulePathEqual

▸ modulePathEqual(first, second): boolean

Determine if module is visible inside from.

This is true when the module path of from starts with the module path of module, and false otherwise.

Parameters

Name	Type
`first`	`ModulePath`
`second`	`ModulePath`

Returns

boolean

Project

Ƭ Project: Object

The

Project including Template asset objects.

Type declaration

Name	Type
`assets`	`Record`<`string`, `string`>
`name`	`string`

Template

Ƭ Template: Object

The

Template describing an end-to-end solution.

Type declaration

Name	Type	Description
`defaults?`	`Record`<`string`, `DefaultDeploymentValue`>	the collection of DefaultDeploymentValues in the solution
`layouts?`	`Record`<`string`, `LayoutVisual`>	the collection of LayoutVisuals in the solution
`modules?`	`Record`<`string`, `Module`>	the collection of Modules in the solution
`streams?`	`Record`<`string`, `Stream`>	the collection of Streams in the solution
`tasks?`	`Record`<`string`, `TaskDescription`>	the collection of TaskDescriptions in the solution

Template

▸ Template(...inputs):

Template

Merge multiple

Template or Builder objects together.

Parameters

Name	Type	Description
`...inputs`	(`Builder` \| `Template`)[]	the Template or Builder objects to merge

Returns

Template

a merged

Template

Example

 const clock = new SourceBuilder("Hourly")
    .clock({ cron: "0 * * * *" })

 const pipeline = new PipelineBuilder("BasicAuth")
     .from(clock.outputStream())
     .transform((value) => StringJoin`The value is ${value}`)

 // create a resulting template
 const template = Template(
     clock, 
     pipeline, 
 )

TemplateDifference

▸ TemplateDifference(first, second): TemplateUpdate

Calculate the difference between two templates.

Parameters

Name	Type	Description
`first`	`Template`	the Template to difference
`second`	`Template`	the Template to difference

Returns

TemplateUpdate

a TemplateUpdate

applyTemplateUpdate

▸ applyTemplateUpdate(template, update):

Template

Apply a difference to a Template.

Parameters

Name	Type	Description
`template`	`Template`	the Template to apply the difference to
`update`	`TemplateUpdate`	the Template difference

Returns

Template

a updated

Template

checkTemplate

▸ checkTemplate(template): void

Check that a template is a valid DAG.

Parameters

Name	Type	Description
`template`	`Template`	the Template or Builder objects to merge

Returns

void