@twin.org/engine-types 0.0.3-next.49 → 0.0.3-next.50

package/docs/reference/functions/initialiseTenantComponent.md

@@ -1,31 +0,0 @@
-# Function: initialiseTenantComponent()
-
-> **initialiseTenantComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`TenantComponentConfig`](../type-aliases/TenantComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-Initialise the tenant component.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`TenantComponentConfig`](../type-aliases/TenantComponentConfig.md)
-
-The instance config.
-
-## Returns
-
-`EngineTypeInitialiserReturn`\<[`TenantComponentConfig`](../type-aliases/TenantComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-The instance created and the factory for it.

package/docs/reference/functions/initialiseUrlTransformerComponent.md

@@ -1,31 +0,0 @@
-# Function: initialiseUrlTransformerComponent()
-
-> **initialiseUrlTransformerComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-Initialise the URL transformer component.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md)
-
-The instance config.
-
-## Returns
-
-`EngineTypeInitialiserReturn`\<[`UrlTransformerComponentConfig`](../type-aliases/UrlTransformerComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-The instance created and the factory for it.

package/docs/reference/type-aliases/TenantComponentConfig.md

@@ -1,17 +0,0 @@
-# Type Alias: TenantComponentConfig
-
-> **TenantComponentConfig** = `object`
-
-Tenant component config types.
-
-## Properties
-
-### type {#type}
-
-> **type**: *typeof* [`Service`](../variables/TenantComponentType.md#service)
-
-***
-
-### options? {#options}
-
-> `optional` **options?**: `ITenantServiceConstructorOptions`

package/docs/reference/type-aliases/TenantComponentType.md

@@ -1,5 +0,0 @@
-# Type Alias: TenantComponentType
-
-> **TenantComponentType** = *typeof* [`TenantComponentType`](../variables/TenantComponentType.md)\[keyof *typeof* [`TenantComponentType`](../variables/TenantComponentType.md)\]
-
-Tenant component types.

package/docs/reference/type-aliases/UrlTransformerComponentConfig.md

@@ -1,17 +0,0 @@
-# Type Alias: UrlTransformerComponentConfig
-
-> **UrlTransformerComponentConfig** = `object`
-
-URL transformer component config types.
-
-## Properties
-
-### type {#type}
-
-> **type**: *typeof* [`Service`](../variables/UrlTransformerComponentType.md#service)
-
-***
-
-### options? {#options}
-
-> `optional` **options?**: `IUrlTransformerServiceConstructorOptions`

package/docs/reference/type-aliases/UrlTransformerComponentType.md

@@ -1,5 +0,0 @@
-# Type Alias: UrlTransformerComponentType
-
-> **UrlTransformerComponentType** = *typeof* [`UrlTransformerComponentType`](../variables/UrlTransformerComponentType.md)\[keyof *typeof* [`UrlTransformerComponentType`](../variables/UrlTransformerComponentType.md)\]
-
-URL transformer component types.

package/docs/reference/variables/UrlTransformerComponentType.md

@@ -1,13 +0,0 @@
-# Variable: UrlTransformerComponentType
-
-> `const` **UrlTransformerComponentType**: `object`
-
-URL transformer component types.
-
-## Type Declaration
-
-### Service {#service}
-
-> `readonly` **Service**: `"service"` = `"service"`
-
-Service.