HotStaq

hotstaq / Modules / HotStaq

Class: HotStaq

The main class that handles all HTML preprocessing, then outputs the results.

Implements

• IHotStaq

Table of contents

Constructors

• constructor

Properties

• api
• apiContent
• components
• files
• hotSite
• logger
• mode
• pageContent
• pages
• publicSecrets
• testerAPI
• testerApiContent
• testers
• isReadyForTesting
• isWeb
• onReadyForTesting

Methods

• addComponent
• addFile
• addPage
• addTester
• createExpressRoutes
• executeAllAPITests
• executeAllWebTests
• executeTests
• generateContent
• getAPITestingMaps
• getComponent
• getFile
• getPage
• getRouteFromName
• getRouteKeyFromName
• getWebTestingMaps
• loadHotFiles
• loadHotSite
• process
• registerComponent
• addHtml
• checkHotSiteName
• displayContent
• displayUrl
• getParam
• getParamDefault
• getValueFromHotSiteObj
• onReady
• parseBoolean
• processContent
• processLocalFile
• processUrl
• replaceKey
• useOutput
• wait
• waitForTesters

Constructors

constructor

• new HotStaq(copy?)

Parameters

Name	Type
copy	IHotStaq

Defined in

HotStaq.ts:440

Properties

api

• api: HotAPI

The api that's used to communicate with.

Implementation of

IHotStaq.api

Defined in

HotStaq.ts:394

---

apiContent

• apiContent: string

The api content to use when about to load HotStaq.

Defined in

HotStaq.ts:418

---

components

• components: Object

The components that can be constructed.

Index signature

▪ [name: string]: HotComponent

Implementation of

IHotStaq.components

Defined in

HotStaq.ts:406

---

files

• files: Object

The files that can be stored for later use.

Index signature

▪ [name: string]: HotFile

Implementation of

IHotStaq.files

Defined in

HotStaq.ts:410

---

hotSite

• hotSite: HotSite

The loaded hotsite.

Implementation of

IHotStaq.hotSite

Defined in

HotStaq.ts:414

---

logger

• logger: HotLog

The logger.

Defined in

HotStaq.ts:430

---

mode

• mode: DeveloperMode

Indicates what type of execution this is.

Implementation of

IHotStaq.mode

Defined in

HotStaq.ts:390

---

pageContent

• pageContent: string

The page content to use when about to load HotStaq.

Defined in

HotStaq.ts:426

---

pages

• pages: Object

The pages that can be constructed.

Index signature

▪ [name: string]: HotPage

Implementation of

IHotStaq.pages

Defined in

HotStaq.ts:402

---

publicSecrets

• publicSecrets: any

The secrets that can be exposed publicly.

Defined in

HotStaq.ts:434

---

testerAPI

• testerAPI: HotAPI

The tester api that's used to communicate with.

Implementation of

IHotStaq.testerAPI

Defined in

HotStaq.ts:398

---

testerApiContent

• testerApiContent: string

The tester api content to use when about to load HotStaq.

Defined in

HotStaq.ts:422

---

testers

• testers: Object

The secrets that can be exposed publicly.

Index signature

▪ [name: string]: HotTester

Defined in

HotStaq.ts:438

---

isReadyForTesting

▪ Static isReadyForTesting: boolean = false

Indicates if this is ready for testing.

Defined in

HotStaq.ts:382

---

isWeb

▪ Static isWeb: boolean = false

Indicates if this is a web build.

Defined in

HotStaq.ts:378

---

onReadyForTesting

▪ Static onReadyForTesting: () => Promise<void> = null

Type declaration

▸ (): Promise<void>

Executes this event when this page is ready for testing.

Returns

Promise<void>

Defined in

HotStaq.ts:386

Methods

addComponent

▸ addComponent(component): void

Add and register a component.

Parameters

Name	Type
component	HotComponent

Returns

void

Defined in

HotStaq.ts:676

---

addFile

▸ addFile(file): void

Add a file.

Parameters

Name	Type
file	HotFile

Returns

void

Defined in

HotStaq.ts:649

---

addPage

▸ addPage(page): void

Add a page.

Parameters

Name	Type
page	HotPage

Returns

void

Defined in

HotStaq.ts:633

---

addTester

▸ addTester(tester): void

Add a tester for use later.

Parameters

Name	Type
tester	HotTester

Returns

void

Defined in

HotStaq.ts:1451

---

createExpressRoutes

▸ createExpressRoutes(expressApp, jsSrcPath?): void

Create the Express routes from the given pages. Be sure to load the pages first before doing this. This method is meant to be used for customized Express applications. If you wish to use the loaded routes from this HotStaq object with HotHTTPServer, be sure to use the loadHotSite method in HotHTTPServer.

Parameters

Name	Type	Default value
expressApp	any	undefined
jsSrcPath	string	"./js/HotStaq.js"

Returns

void

Defined in

HotStaq.ts:1434

---

executeAllAPITests

▸ executeAllAPITests(testerName): Promise<void>

Execute all api tests from the HotSite testing api object.

Parameters

Name	Type	Description
testerName	string	The tester to use to execute tests.

Returns

Promise<void>

Defined in

HotStaq.ts:1580

---

executeAllWebTests

▸ executeAllWebTests(testerName): Promise<void>

Execute all web tests from the HotSite testing web object.

Parameters

Name	Type	Description
testerName	string	The tester to use to execute tests.

Returns

Promise<void>

Defined in

HotStaq.ts:1559

---

executeTests

▸ executeTests(testerName, mapName): Promise<void>

Execute tests.

Parameters

Name	Type	Description
testerName	string	The tester to use to execute tests.
mapName	string	The map or maps to use to navigate through tests.

Returns

Promise<void>

Defined in

HotStaq.ts:1544

---

generateContent

▸ generateContent(routeKey, name?, url?, jsSrcPath?, passArgs?, args?): string

Generate the content to send to a client.

Parameters

Name	Type	Default value
routeKey	string	undefined
name	string	""
url	string	"./"
jsSrcPath	string	"./js/HotStaq.js"
passArgs	boolean	true
args	any	null

Returns

string

Defined in

HotStaq.ts:1149

---

getAPITestingMaps

▸ getAPITestingMaps(): string[]

Get the list of maps for testing from the HotSite.

Returns

string[]

Defined in

HotStaq.ts:1479

---

getComponent

▸ getComponent(name): HotComponent

Get a component to process.

Parameters

Name	Type
name	string

Returns

HotComponent

Defined in

HotStaq.ts:746

---

getFile

▸ getFile(name): HotFile

Get a file.

Parameters

Name	Type
name	string

Returns

HotFile

Defined in

HotStaq.ts:665

---

getPage

▸ getPage(pageName): HotPage

Get a page to process.

Parameters

Name	Type
pageName	string

Returns

HotPage

Defined in

HotStaq.ts:641

---

getRouteFromName

▸ getRouteFromName(name): HotSiteRoute

Get a route from a route's name.

Parameters

Name	Type
name	string

Returns

HotSiteRoute

Defined in

HotStaq.ts:1527

---

getRouteKeyFromName

▸ getRouteKeyFromName(name): string

Get a route's key from a route's name.

Parameters

Name	Type
name	string

Returns

string

Defined in

HotStaq.ts:1499

---

getWebTestingMaps

▸ getWebTestingMaps(): string[]

Get the list of maps for testing from the HotSite.

Returns

string[]

Defined in

HotStaq.ts:1459

---

loadHotFiles

▸ loadHotFiles(files, forceContentLoading?): Promise<void>

Load an array of files. If a file already has content, it will not be reloaded unless forceContentLoading is set to true.

Parameters

Name	Type	Default value
files	Object	undefined
forceContentLoading	boolean	false

Returns

Promise<void>

Defined in

HotStaq.ts:1098

---

loadHotSite

▸ loadHotSite(path): Promise<void>

Load from a HotSite.json file. Be sure to load and attach any testers before loading a HotSite.

Parameters

Name	Type
path	string

Returns

Promise<void>

Defined in

HotStaq.ts:862

---

process

▸ process(pageName, args?): Promise<string>

Process a page and get the result.

Parameters

Name	Type	Default value
pageName	string	undefined
args	any	null

Returns

Promise<string>

Defined in

HotStaq.ts:1599

---

registerComponent

▸ registerComponent(component): void

Register a component for use as a HTML tag.

Parameters

Name	Type
component	HotComponent

Returns

void

Defined in

HotStaq.ts:685

---

addHtml

▸ Static addHtml(parent, html): HTMLElement | HTMLElement[]

Add a new HTML element(s) to the current document.

Parameters

Name	Type
parent	string | HTMLElement
html	string | HTMLElement

Returns

HTMLElement | HTMLElement[]

Defined in

HotStaq.ts:754

---

checkHotSiteName

▸ Static checkHotSiteName(hotsiteName, throwException?): boolean

Check if a HotSite's name is valid.

Parameters

Name	Type	Default value
hotsiteName	string	undefined
throwException	boolean	false

Returns

boolean

Defined in

HotStaq.ts:791

---

displayContent

▸ Static displayContent(content, name, processor?): Promise<HotStaq>

Process and replace the current HTML page with the hott script. This is meant for web browser use only.

Parameters

Name	Type	Default value
content	string	undefined
name	string	undefined
processor	HotStaq	null

Returns

Promise<HotStaq>

Defined in

HotStaq.ts:1864

---

displayUrl

▸ Static displayUrl(url, name?, processor?, args?): Promise<HotStaq>

Process and replace the current HTML page with the hott script from the given url. This is meant for web browser use only.

Parameters

Name	Type	Default value
url	string | HotStartOptions	undefined
name	string	null
processor	HotStaq	null
args	any	null

Returns

Promise<HotStaq>

Defined in

HotStaq.ts:1714

---

getParam

▸ Static getParam(name, objWithParam, required?, throwException?): any

Check if a required parameter exists inside an object. If it exists, return the value.

Parameters

Name	Type	Default value
name	string	undefined
objWithParam	any	undefined
required	boolean	true
throwException	boolean	true

Returns

any

Defined in

HotStaq.ts:568

---

getParamDefault

▸ Static getParamDefault(name, objWithParam, defaultValue): any

Check if a required parameter exists inside an object. If it exists, return the value. If it does not exist, return a default value instead.

Parameters

Name	Type
name	string
objWithParam	any
defaultValue	any

Returns

any

Defined in

HotStaq.ts:600

---

getValueFromHotSiteObj

▸ Static getValueFromHotSiteObj(hotsite, params): any

Get a value from a HotSite object.

Parameters

Name	Type
hotsite	HotSite
params	string[]

Returns

any

Returns the value from the hotsite object. Returns null if it doesn't exist.

Defined in

HotStaq.ts:827

---

onReady

▸ Static onReady(readyFunc): void

When the window has finished loading, execute the function. This is meant for web browser use only.

Parameters

Name	Type
readyFunc	() => void

Returns

void

Defined in

HotStaq.ts:1676

---

parseBoolean

▸ Static parseBoolean(value): boolean

Parse a boolean value.

Parameters

Name	Type
value	string

Returns

boolean

Defined in

HotStaq.ts:531

---

processContent

▸ Static processContent(processor, content, name, args?): Promise<string>

Process content and get the result.

Parameters

Name	Type	Default value
processor	HotStaq	undefined
content	string	undefined
name	string	undefined
args	any	null

Returns

Promise<string>

Defined in

HotStaq.ts:1654

---

processLocalFile

▸ Static processLocalFile(localFilepath, name?, args?): Promise<string>

Process a local file and get the result.

Parameters

Name	Type	Default value
localFilepath	string	undefined
name	string	localFilepath
args	any	null

Returns

Promise<string>

Defined in

HotStaq.ts:1610

---

processUrl

▸ Static processUrl(options): Promise<string>

Process a url and get the result.

Parameters

Name	Type
options	HotStartOptions

Returns

Promise<string>

Defined in

HotStaq.ts:1631

---

replaceKey

▸ Static replaceKey(content, key, value): string

In the supplied content, replace a key in a ${KEY} with a value.

Parameters

Name	Type
content	string
key	string
value	string

Returns

string

The content with the correct values.

Defined in

HotStaq.ts:815

---

useOutput

▸ Static useOutput(output): void

Replace the current HTML page with the output. This is meant for web browser use only.

Parameters

Name	Type
output	string

Returns

void

Defined in

HotStaq.ts:1688

---

wait

▸ Static wait(numMilliseconds): Promise<void>

Wait for a number of milliseconds.

Parameters

Name	Type
numMilliseconds	number

Returns

Promise<void>

Defined in

HotStaq.ts:619

---

waitForTesters

▸ Static waitForTesters(): Promise<void>

Wait for testers to load.

fixme This does not wait for ALL testers to finish loading. Only the first one.

Returns

Promise<void>

Defined in

HotStaq.ts:1701