hotstaq 0.5.24

package/docs/interfaces/HotSiteRoute.md

@@ -0,0 +1,79 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotSiteRoute
+
+# Interface: HotSiteRoute
+
+A route used in a HotSite.
+
+## Table of contents
+
+### Properties
+
+- [api](HotSiteRoute.md#api)
+- [destinationOrder](HotSiteRoute.md#destinationorder)
+- [map](HotSiteRoute.md#map)
+- [name](HotSiteRoute.md#name)
+- [url](HotSiteRoute.md#url)
+
+## Properties
+
+### api
+
+• `Optional` **api**: `string`
+
+The name of the API to interface with.
+
+#### Defined in
+
+[HotStaq.ts:58](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L58)
+
+___
+
+### destinationOrder
+
+• `Optional` **destinationOrder**: `string`[]
+
+The order in which destinations are supposed to execute. This is
+ignored if the destinations are an array.
+
+#### Defined in
+
+[HotStaq.ts:63](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L63)
+
+___
+
+### map
+
+• `Optional` **map**: `string` \| `string`[] \| { [name: string]: `string` \| [`HotSiteMapPath`](HotSiteMapPath.md);  } \| [`HotSiteMapPath`](HotSiteMapPath.md)[]
+
+The HotTesterMap to use. This can be the name of an
+existing one attached to the selected tester, or
+can be an array of destinations that will be used to
+create a new map.
+
+#### Defined in
+
+[HotStaq.ts:70](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L70)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the route. Will appear in the title.
+
+#### Defined in
+
+[HotStaq.ts:50](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L50)
+
+___
+
+### url
+
+• **url**: `string`
+
+The url to the file to load.
+
+#### Defined in
+
+[HotStaq.ts:54](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L54)

package/docs/interfaces/HotStartOptions.md

@@ -0,0 +1,115 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotStartOptions
+
+# Interface: HotStartOptions
+
+The options to use when starting a page.
+
+## Table of contents
+
+### Properties
+
+- [args](HotStartOptions.md#args)
+- [name](HotStartOptions.md#name)
+- [processor](HotStartOptions.md#processor)
+- [testerAPIBaseUrl](HotStartOptions.md#testerapibaseurl)
+- [testerLaunchpadUrl](HotStartOptions.md#testerlaunchpadurl)
+- [testerMap](HotStartOptions.md#testermap)
+- [testerName](HotStartOptions.md#testername)
+- [url](HotStartOptions.md#url)
+
+## Properties
+
+### args
+
+• `Optional` **args**: `any`
+
+Any arguments to pass to the new page.
+
+#### Defined in
+
+[HotStaq.ts:313](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L313)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+The name of the page to load.
+
+#### Defined in
+
+[HotStaq.ts:305](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L305)
+
+___
+
+### processor
+
+• `Optional` **processor**: [`HotStaq`](../classes/HotStaq.md)
+
+The processor to use to load the page.
+
+#### Defined in
+
+[HotStaq.ts:309](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L309)
+
+___
+
+### testerAPIBaseUrl
+
+• `Optional` **testerAPIBaseUrl**: `string`
+
+The base url for the tester api.
+
+#### Defined in
+
+[HotStaq.ts:325](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L325)
+
+___
+
+### testerLaunchpadUrl
+
+• `Optional` **testerLaunchpadUrl**: `string`
+
+The url to the html that loads the hott file that's
+pointed at the url above.
+
+#### Defined in
+
+[HotStaq.ts:330](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L330)
+
+___
+
+### testerMap
+
+• `Optional` **testerMap**: `string`
+
+The name of the tester map to use.
+
+#### Defined in
+
+[HotStaq.ts:321](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L321)
+
+___
+
+### testerName
+
+• `Optional` **testerName**: `string`
+
+The name of the tester to use.
+
+#### Defined in
+
+[HotStaq.ts:317](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L317)
+
+___
+
+### url
+
+• **url**: `string`
+
+The Hott site to load.
+
+#### Defined in
+
+[HotStaq.ts:301](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L301)

package/docs/interfaces/HotTestPage.md

@@ -0,0 +1,44 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestPage
+
+# Interface: HotTestPage
+
+A page containing only test related info.
+
+## Table of contents
+
+### Properties
+
+- [testElements](HotTestPage.md#testelements)
+- [testPaths](HotTestPage.md#testpaths)
+
+## Properties
+
+### testElements
+
+• **testElements**: `Object`
+
+The elements to test on this map.
+
+#### Index signature
+
+▪ [name: `string`]: [`HotTestElement`](../classes/HotTestElement.md)
+
+#### Defined in
+
+[HotTestMap.ts:56](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L56)
+
+___
+
+### testPaths
+
+• **testPaths**: `Object`
+
+The test paths to test on this map.
+
+#### Index signature
+
+▪ [name: `string`]: [`HotTestPath`](../modules.md#hottestpath)
+
+#### Defined in
+
+[HotTestMap.ts:60](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestMap.ts#L60)

package/docs/interfaces/HotTestStop.md

@@ -0,0 +1,62 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotTestStop
+
+# Interface: HotTestStop
+
+The test stop that is executed as either a destination or
+a path.
+
+## Table of contents
+
+### Properties
+
+- [cmd](HotTestStop.md#cmd)
+- [dest](HotTestStop.md#dest)
+- [path](HotTestStop.md#path)
+
+## Properties
+
+### cmd
+
+• **cmd**: `string`
+
+A command to execute. Can be:
+* print(x)
+  * Print a message to the server's console.
+* println(x)
+  * Print a message with a new line to the server's console.
+* url(x)
+  * Open a url. Must be an absolute url.
+* waitForTesterAPIData
+  * This will wait for the tester API to receive data.
+* wait(x)
+  * This will wait for x number of milliseconds.
+* waitForTestObject(x)
+  * This will wait for a test object to be loaded.
+
+#### Defined in
+
+[HotTester.ts:28](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTester.ts#L28)
+
+___
+
+### dest
+
+• **dest**: `string`
+
+The destination to execute.
+
+#### Defined in
+
+[HotTester.ts:32](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTester.ts#L32)
+
+___
+
+### path
+
+• **path**: `string`
+
+The path to execute.
+
+#### Defined in
+
+[HotTester.ts:36](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTester.ts#L36)

package/docs/interfaces/IHotComponent.md

@@ -0,0 +1,135 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / IHotComponent
+
+# Interface: IHotComponent
+
+A component to preprocess.
+
+## Implemented by
+
+- [`HotComponent`](../classes/HotComponent.md)
+
+## Table of contents
+
+### Properties
+
+- [api](IHotComponent.md#api)
+- [elementOptions](IHotComponent.md#elementoptions)
+- [events](IHotComponent.md#events)
+- [htmlElement](IHotComponent.md#htmlelement)
+- [name](IHotComponent.md#name)
+- [processor](IHotComponent.md#processor)
+- [tag](IHotComponent.md#tag)
+- [type](IHotComponent.md#type)
+- [value](IHotComponent.md#value)
+
+## Properties
+
+### api
+
+• `Optional` **api**: [`HotAPI`](../classes/HotAPI.md)
+
+The connected API.
+
+#### Defined in
+
+[HotComponent.ts:28](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L28)
+
+___
+
+### elementOptions
+
+• `Optional` **elementOptions**: `ElementDefinitionOptions`
+
+The options to include with registering this component.
+
+#### Defined in
+
+[HotComponent.ts:32](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L32)
+
+___
+
+### events
+
+• `Optional` **events**: `Object`
+
+The events to trigger.
+
+#### Index signature
+
+▪ [name: `string`]: { `func`: `Function` ; `options?`: `any` ; `type`: `string`  }
+
+#### Defined in
+
+[HotComponent.ts:44](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L44)
+
+___
+
+### htmlElement
+
+• `Optional` **htmlElement**: `HTMLElement`
+
+The associated HTMLElement.
+
+#### Defined in
+
+[HotComponent.ts:16](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L16)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+The name of the page.
+
+#### Defined in
+
+[HotComponent.ts:20](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L20)
+
+___
+
+### processor
+
+• **processor**: [`HotStaq`](../classes/HotStaq.md)
+
+The processor to use.
+
+#### Defined in
+
+[HotComponent.ts:12](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L12)
+
+___
+
+### tag
+
+• `Optional` **tag**: `string`
+
+The name of the tag.
+
+#### Defined in
+
+[HotComponent.ts:24](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L24)
+
+___
+
+### type
+
+• `Optional` **type**: `string`
+
+The type of component.
+
+#### Defined in
+
+[HotComponent.ts:36](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L36)
+
+___
+
+### value
+
+• `Optional` **value**: `any`
+
+The value of the component.
+
+#### Defined in
+
+[HotComponent.ts:40](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L40)

package/docs/interfaces/IHotStaq.md

@@ -0,0 +1,118 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / IHotStaq
+
+# Interface: IHotStaq
+
+The main class that handles all HTML preprocessing, then outputs the
+results.
+
+## Implemented by
+
+- [`HotStaq`](../classes/HotStaq.md)
+
+## Table of contents
+
+### Properties
+
+- [api](IHotStaq.md#api)
+- [components](IHotStaq.md#components)
+- [files](IHotStaq.md#files)
+- [hotSite](IHotStaq.md#hotsite)
+- [mode](IHotStaq.md#mode)
+- [pages](IHotStaq.md#pages)
+- [testerAPI](IHotStaq.md#testerapi)
+
+## Properties
+
+### api
+
+• `Optional` **api**: [`HotAPI`](../classes/HotAPI.md)
+
+The api that's used to communicate with.
+
+#### Defined in
+
+[HotStaq.ts:342](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L342)
+
+___
+
+### components
+
+• `Optional` **components**: `Object`
+
+The components that can be constructed.
+
+#### Index signature
+
+▪ [name: `string`]: [`HotComponent`](../classes/HotComponent.md)
+
+#### Defined in
+
+[HotStaq.ts:358](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L358)
+
+___
+
+### files
+
+• `Optional` **files**: `Object`
+
+The files that can be stored for later use.
+
+#### Index signature
+
+▪ [name: `string`]: [`HotFile`](../classes/HotFile.md)
+
+#### Defined in
+
+[HotStaq.ts:362](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L362)
+
+___
+
+### hotSite
+
+• `Optional` **hotSite**: [`HotSite`](HotSite.md)
+
+The loaded hotsite.
+
+#### Defined in
+
+[HotStaq.ts:366](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L366)
+
+___
+
+### mode
+
+• `Optional` **mode**: [`DeveloperMode`](../enums/DeveloperMode.md)
+
+Indicates what type of execution this is.
+
+#### Defined in
+
+[HotStaq.ts:350](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L350)
+
+___
+
+### pages
+
+• `Optional` **pages**: `Object`
+
+The pages that can be constructed.
+
+#### Index signature
+
+▪ [name: `string`]: [`HotPage`](../classes/HotPage.md)
+
+#### Defined in
+
+[HotStaq.ts:354](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L354)
+
+___
+
+### testerAPI
+
+• `Optional` **testerAPI**: [`HotAPI`](../classes/HotAPI.md)
+
+The tester api that's used to communicate with.
+
+#### Defined in
+
+[HotStaq.ts:346](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotStaq.ts#L346)

package/docs/interfaces/IHotTestElement.md

@@ -0,0 +1,54 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / IHotTestElement
+
+# Interface: IHotTestElement
+
+A test element.
+
+## Implemented by
+
+- [`HotTestElement`](../classes/HotTestElement.md)
+
+## Table of contents
+
+### Properties
+
+- [func](IHotTestElement.md#func)
+- [name](IHotTestElement.md#name)
+- [value](IHotTestElement.md#value)
+
+## Properties
+
+### func
+
+• `Optional` **func**: `string`
+
+The name of the function to execute
+while executing the test.
+
+#### Defined in
+
+[HotTestElement.ts:56](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L56)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the element.
+
+#### Defined in
+
+[HotTestElement.ts:51](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L51)
+
+___
+
+### value
+
+• `Optional` **value**: `any`
+
+The value to use.
+
+#### Defined in
+
+[HotTestElement.ts:60](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L60)

package/docs/interfaces/IHotTestElementOptions.md

@@ -0,0 +1,43 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / IHotTestElementOptions
+
+# Interface: IHotTestElementOptions
+
+Hot test element options.
+
+## Implemented by
+
+- [`HotTestElementOptions`](../classes/HotTestElementOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [ignoreMissingElementError](IHotTestElementOptions.md#ignoremissingelementerror)
+- [mustBeVisible](IHotTestElementOptions.md#mustbevisible)
+
+## Properties
+
+### ignoreMissingElementError
+
+• `Optional` **ignoreMissingElementError**: `boolean`
+
+If the test element is missing, ignore the error. This
+will cause the rest of the function to return immediately
+without any exceptions being thrown.
+
+#### Defined in
+
+[HotTestElement.ts:16](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L16)
+
+___
+
+### mustBeVisible
+
+• `Optional` **mustBeVisible**: `boolean`
+
+Indicates that the test element must be visible in
+order to select it.
+
+#### Defined in
+
+[HotTestElement.ts:10](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotTestElement.ts#L10)

package/docs/interfaces/MySQLResults.md

@@ -0,0 +1,43 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / MySQLResults
+
+# Interface: MySQLResults
+
+The database results.
+
+## Table of contents
+
+### Properties
+
+- [error](MySQLResults.md#error)
+- [fields](MySQLResults.md#fields)
+- [results](MySQLResults.md#results)
+
+## Properties
+
+### error
+
+• **error**: `any`
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:17](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/schemas/HotDBMySQL.ts#L17)
+
+___
+
+### fields
+
+• **fields**: `FieldInfo`[]
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:19](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/schemas/HotDBMySQL.ts#L19)
+
+___
+
+### results
+
+• **results**: `any`
+
+#### Defined in
+
+[schemas/HotDBMySQL.ts:18](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/schemas/HotDBMySQL.ts#L18)