hotstaq 0.5.24

package/docs/classes/HotComponent.md

@@ -0,0 +1,279 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotComponent
+
+# Class: HotComponent
+
+A component to preprocess.
+
+## Implements
+
+- [`IHotComponent`](../interfaces/IHotComponent.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotComponent.md#constructor)
+
+### Properties
+
+- [api](HotComponent.md#api)
+- [elementOptions](HotComponent.md#elementoptions)
+- [events](HotComponent.md#events)
+- [htmlElement](HotComponent.md#htmlelement)
+- [name](HotComponent.md#name)
+- [processor](HotComponent.md#processor)
+- [tag](HotComponent.md#tag)
+- [type](HotComponent.md#type)
+- [value](HotComponent.md#value)
+
+### Methods
+
+- [click](HotComponent.md#click)
+- [handleAttributes](HotComponent.md#handleattributes)
+- [onCreated](HotComponent.md#oncreated)
+- [output](HotComponent.md#output)
+
+## Constructors
+
+### constructor
+
+• **new HotComponent**(`copy`, `api?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `copy` | [`HotStaq`](HotStaq.md) \| [`IHotComponent`](../interfaces/IHotComponent.md) | `undefined` |
+| `api` | [`HotAPI`](HotAPI.md) | `null` |
+
+#### Defined in
+
+[HotComponent.ts:101](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L101)
+
+## Properties
+
+### api
+
+• **api**: [`HotAPI`](HotAPI.md)
+
+The connected API.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[api](../interfaces/IHotComponent.md#api)
+
+#### Defined in
+
+[HotComponent.ts:77](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L77)
+
+___
+
+### elementOptions
+
+• **elementOptions**: `ElementDefinitionOptions`
+
+The options to include with registering this component.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[elementOptions](../interfaces/IHotComponent.md#elementoptions)
+
+#### Defined in
+
+[HotComponent.ts:81](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L81)
+
+___
+
+### events
+
+• **events**: `Object`
+
+The events to trigger.
+
+#### Index signature
+
+▪ [name: `string`]: { `func`: `Function` ; `options`: `any` ; `type`: `string`  }
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[events](../interfaces/IHotComponent.md#events)
+
+#### Defined in
+
+[HotComponent.ts:93](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L93)
+
+___
+
+### htmlElement
+
+• **htmlElement**: `HTMLElement`
+
+The associated HTMLElement.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[htmlElement](../interfaces/IHotComponent.md#htmlelement)
+
+#### Defined in
+
+[HotComponent.ts:65](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L65)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name of the component.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[name](../interfaces/IHotComponent.md#name)
+
+#### Defined in
+
+[HotComponent.ts:69](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L69)
+
+___
+
+### processor
+
+• **processor**: [`HotStaq`](HotStaq.md)
+
+The processor to use.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[processor](../interfaces/IHotComponent.md#processor)
+
+#### Defined in
+
+[HotComponent.ts:61](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L61)
+
+___
+
+### tag
+
+• **tag**: `string`
+
+The name of the tag.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[tag](../interfaces/IHotComponent.md#tag)
+
+#### Defined in
+
+[HotComponent.ts:73](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L73)
+
+___
+
+### type
+
+• **type**: `string`
+
+The type of component.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[type](../interfaces/IHotComponent.md#type)
+
+#### Defined in
+
+[HotComponent.ts:85](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L85)
+
+___
+
+### value
+
+• **value**: `any`
+
+The value of the component.
+
+#### Implementation of
+
+[IHotComponent](../interfaces/IHotComponent.md).[value](../interfaces/IHotComponent.md#value)
+
+#### Defined in
+
+[HotComponent.ts:89](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L89)
+
+## Methods
+
+### click
+
+▸ `Abstract` **click**(): `Promise`<`void`\>
+
+Handle a click event.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotComponent.ts:152](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L152)
+
+___
+
+### handleAttributes
+
+▸ `Optional` **handleAttributes**(`attributes`): `Promise`<`void`\>
+
+Handle the attributes manually.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `attributes` | `NamedNodeMap` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotComponent.ts:147](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L147)
+
+___
+
+### onCreated
+
+▸ **onCreated**(`element`): `Promise`<`any`\>
+
+Event that's called when this component is created. This is
+called before output is called. Right after this is called,
+the attributes from the HTMLElement will be processed. If
+the functionality of the attributes processing need to be
+overwritten, use the handleAttributes method to handle them.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `element` | `HTMLElement` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotComponent.ts:139](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L139)
+
+___
+
+### output
+
+▸ `Abstract` **output**(): `Promise`<`string`\>
+
+Output the component.
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[HotComponent.ts:157](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotComponent.ts#L157)

package/docs/classes/HotDB.md

@@ -0,0 +1,247 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / HotDB
+
+# Class: HotDB<DBType, DBResultType, DBSchema\>
+
+The server-side database connection.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `DBType` | `any` |
+| `DBResultType` | `any` |
+| `DBSchema` | [`HotDBSchema`](HotDBSchema.md) |
+
+## Hierarchy
+
+- **`HotDB`**
+
+  ↳ [`HotDBMySQL`](HotDBMySQL.md)
+
+  ↳ [`HotDBInflux`](HotDBInflux.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HotDB.md#constructor)
+
+### Properties
+
+- [connectionStatus](HotDB.md#connectionstatus)
+- [db](HotDB.md#db)
+- [schema](HotDB.md#schema)
+- [type](HotDB.md#type)
+
+### Methods
+
+- [connect](HotDB.md#connect)
+- [disconnect](HotDB.md#disconnect)
+- [multiQuery](HotDB.md#multiquery)
+- [query](HotDB.md#query)
+- [queryOne](HotDB.md#queryone)
+- [tableCheck](HotDB.md#tablecheck)
+
+## Constructors
+
+### constructor
+
+• **new HotDB**<`DBType`, `DBResultType`, `DBSchema`\>(`db?`, `type?`, `schema?`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `DBType` | `any` |
+| `DBResultType` | `any` |
+| `DBSchema` | [`HotDBSchema`](HotDBSchema.md) |
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `db` | `DBType` | `null` |
+| `type` | `string` | `""` |
+| `schema` | `DBSchema` | `null` |
+
+#### Defined in
+
+[HotDB.ts:37](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L37)
+
+## Properties
+
+### connectionStatus
+
+• **connectionStatus**: [`ConnectionStatus`](../enums/ConnectionStatus.md)
+
+The connection status.
+
+#### Defined in
+
+[HotDB.ts:30](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L30)
+
+___
+
+### db
+
+• **db**: `DBType`
+
+The connection to the database (or the driver).
+
+#### Defined in
+
+[HotDB.ts:26](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L26)
+
+___
+
+### schema
+
+• **schema**: `DBSchema`
+
+The db schema. This will generate a database structure
+and keep it maintained as needed.
+
+#### Defined in
+
+[HotDB.ts:35](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L35)
+
+___
+
+### type
+
+• **type**: `string`
+
+The database type.
+
+#### Defined in
+
+[HotDB.ts:22](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L22)
+
+## Methods
+
+### connect
+
+▸ `Abstract` **connect**(`connectionInfo`): `Promise`<`any`[]\>
+
+Connect to the database. This will only start connecting
+if db is null.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connectionInfo` | [`HotDBConnectionInterface`](../interfaces/HotDBConnectionInterface.md) |
+
+#### Returns
+
+`Promise`<`any`[]\>
+
+#### Defined in
+
+[HotDB.ts:49](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L49)
+
+___
+
+### disconnect
+
+▸ `Abstract` **disconnect**(): `Promise`<`void`\>
+
+Disconnect from the server.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[HotDB.ts:78](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L78)
+
+___
+
+### multiQuery
+
+▸ `Optional` `Abstract` **multiQuery**(`queryStrings`): `Promise`<`DBResultType`[]\>
+
+Make multiple queries.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `queryStrings` | `string`[] \| { `query`: `string` ; `values`: `any`[]  }[] |
+
+#### Returns
+
+`Promise`<`DBResultType`[]\>
+
+#### Defined in
+
+[HotDB.ts:74](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L74)
+
+___
+
+### query
+
+▸ `Optional` `Abstract` **query**(`queryString`, `values?`): `Promise`<`DBResultType`\>
+
+The query to make.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `queryString` | `string` |
+| `values?` | `any`[] |
+
+#### Returns
+
+`Promise`<`DBResultType`\>
+
+#### Defined in
+
+[HotDB.ts:66](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L66)
+
+___
+
+### queryOne
+
+▸ `Optional` `Abstract` **queryOne**(`queryString`, `values?`): `Promise`<`DBResultType`\>
+
+Make a single query.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `queryString` | `string` |
+| `values?` | `any`[] |
+
+#### Returns
+
+`Promise`<`DBResultType`\>
+
+#### Defined in
+
+[HotDB.ts:70](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L70)
+
+___
+
+### tableCheck
+
+▸ `Optional` `Abstract` **tableCheck**(`tableName`): `Promise`<`boolean`\>
+
+Checks if the table exists.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tableName` | `string` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+[HotDB.ts:62](https://github.com/OurFreeLight/HotStaq/blob/3f2c5d8/src/HotDB.ts#L62)