@genesislcap/foundation-testing 14.408.0 → 14.409.0

package/docs/api/foundation-testing.createlogicsuite.md

@@ -1,99 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [createLogicSuite](./foundation-testing.createlogicsuite.md)
-
-## createLogicSuite() function
-
-Create logic test suite.
-
-**Signature:**
-
-```typescript
-export declare function createLogicSuite<TContext = LogicContext>(title: string, context?: TContext): uvu.Test<TContext>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-title
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Title of the test suite
-
-
-</td></tr>
-<tr><td>
-
-context
-
-
-</td><td>
-
-TContext
-
-
-</td><td>
-
-_(Optional)_ Optional context which extends [LogicContext](./foundation-testing.logiccontext.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-uvu.Test&lt;TContext&gt;
-
-The test suite
-
-## Remarks
-
-Used to test function output given certain input arguments.
-
-## Example
-
-
-```ts
-import { createLogicSuite } from '@genesislcap/foundation-testing';
-import { myFunction } from './logic';
-const Suite = createLogicSuite('myFunction');
-Suite('myFunction should provide expected results', ({ runCases }) => {
-  runCases(myFunction, [
-    [['1'], true],
-    [[123], true],
-    [['60%'], true],
-    [['$60'], false],
-    [['1.1'], false],
-    [[''], false],
-    [[true], false],
-    [[null], false],
-    [[undefined], false],
-  ]);
-});
-Suite.run();
-```
-

package/docs/api/foundation-testing.delayedresolve.md

@@ -1,80 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [delayedResolve](./foundation-testing.delayedresolve.md)
-
-## delayedResolve() function
-
-Delayed resolve utility.
-
-**Signature:**
-
-```typescript
-delayedResolve: (result: unknown, duration?: number) => () => Promise<unknown>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-result
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-The result of the promise.
-
-
-</td></tr>
-<tr><td>
-
-duration
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ An optional duration in milliseconds. Defaults to 500.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-() =&gt; Promise&lt;unknown&gt;
-
-## Example
-
-
-```ts
-test('delayed resolve', async () => {
-  const mockAPI = delayedResolve({ foo: 'bar' }, 2_000);
-  const result = await mockAPI();
-});
-```
-

package/docs/api/foundation-testing.elementgetter.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [ElementGetter](./foundation-testing.elementgetter.md)
-
-## ElementGetter type
-
-
-**Signature:**
-
-```typescript
-export type ElementGetter = () => FoundationElementRegistry<FoundationElementDefinition, FoundationElement>;
-```

package/docs/api/foundation-testing.equal.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Equal](./foundation-testing.equal.md)
-
-## Equal type
-
-Expects that the type parameter X is equal to Y, returning true or false
-
-**Signature:**
-
-```typescript
-export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
-```

package/docs/api/foundation-testing.expect.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Expect](./foundation-testing.expect.md)
-
-## Expect type
-
-Expects that the type parameter T resolves to true, or will be a typescript error
-
-**Signature:**
-
-```typescript
-export type Expect<T extends true> = T;
-```

package/docs/api/foundation-testing.filterconditionally.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FilterConditionally](./foundation-testing.filterconditionally.md)
-
-## FilterConditionally type
-
-Filters out key/value pairs from an object where they value does not match a condition
-
-**Signature:**
-
-```typescript
-export type FilterConditionally<Source, Condition> = Pick<Source, {
-    [K in keyof Source]: Source[K] extends Condition ? K : never;
-}[keyof Source]>;
-```

package/docs/api/foundation-testing.fixture.connect.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [connect](./foundation-testing.fixture.connect.md)
-
-## Fixture.connect() method
-
-Adds the [Fixture.parent](./foundation-testing.fixture.parent.md) to the DOM, causing the connect lifecycle to begin.
-
-**Signature:**
-
-```typescript
-connect(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-
-## Remarks
-
-Yields control to the caller one Microtask later, in order to ensure that the DOM has settled.
-

package/docs/api/foundation-testing.fixture.disconnect.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [disconnect](./foundation-testing.fixture.disconnect.md)
-
-## Fixture.disconnect() method
-
-Removes the [Fixture.parent](./foundation-testing.fixture.parent.md) from the DOM, causing the disconnect lifecycle to begin.
-
-**Signature:**
-
-```typescript
-disconnect(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-
-## Remarks
-
-Yields control to the caller one Microtask later, in order to ensure that the DOM has settled.
-

package/docs/api/foundation-testing.fixture.document.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [document](./foundation-testing.fixture.document.md)
-
-## Fixture.document property
-
-The document the fixture is running in.
-
-**Signature:**
-
-```typescript
-document: Document;
-```

package/docs/api/foundation-testing.fixture.element.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [element](./foundation-testing.fixture.element.md)
-
-## Fixture.element property
-
-The first element in the [Fixture.view](./foundation-testing.fixture.view.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-element: TElement;
-```

package/docs/api/foundation-testing.fixture.md

@@ -1,171 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md)
-
-## Fixture interface
-
-Unit test fixture.
-
-**Signature:**
-
-```typescript
-export interface Fixture<TElement = HTMLElement> 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[document](./foundation-testing.fixture.document.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Document
-
-
-</td><td>
-
-The document the fixture is running in.
-
-
-</td></tr>
-<tr><td>
-
-[element](./foundation-testing.fixture.element.md)
-
-
-</td><td>
-
-
-</td><td>
-
-TElement
-
-
-</td><td>
-
-The first element in the [Fixture.view](./foundation-testing.fixture.view.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[parent](./foundation-testing.fixture.parent.md)
-
-
-</td><td>
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-The parent element that the view was appended to.
-
-
-</td></tr>
-<tr><td>
-
-[template](./foundation-testing.fixture.template.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ViewTemplate
-
-
-</td><td>
-
-The template the fixture was created from.
-
-
-</td></tr>
-<tr><td>
-
-[view](./foundation-testing.fixture.view.md)
-
-
-</td><td>
-
-
-</td><td>
-
-HTMLView
-
-
-</td><td>
-
-The view that was created from the fixture's template.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[connect()](./foundation-testing.fixture.connect.md)
-
-
-</td><td>
-
-Adds the [Fixture.parent](./foundation-testing.fixture.parent.md) to the DOM, causing the connect lifecycle to begin.
-
-
-</td></tr>
-<tr><td>
-
-[disconnect()](./foundation-testing.fixture.disconnect.md)
-
-
-</td><td>
-
-Removes the [Fixture.parent](./foundation-testing.fixture.parent.md) from the DOM, causing the disconnect lifecycle to begin.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-testing.fixture.parent.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [parent](./foundation-testing.fixture.parent.md)
-
-## Fixture.parent property
-
-The parent element that the view was appended to.
-
-**Signature:**
-
-```typescript
-parent: HTMLElement;
-```
-
-## Remarks
-
-This element will be appended to the DOM only after [Fixture.connect()](./foundation-testing.fixture.connect.md) has been called.
-

package/docs/api/foundation-testing.fixture.template.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [template](./foundation-testing.fixture.template.md)
-
-## Fixture.template property
-
-The template the fixture was created from.
-
-**Signature:**
-
-```typescript
-template: ViewTemplate;
-```

package/docs/api/foundation-testing.fixture.view.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [Fixture](./foundation-testing.fixture.md) &gt; [view](./foundation-testing.fixture.view.md)
-
-## Fixture.view property
-
-The view that was created from the fixture's template.
-
-**Signature:**
-
-```typescript
-view: HTMLView;
-```

package/docs/api/foundation-testing.fixtureoptions.context.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FixtureOptions](./foundation-testing.fixtureoptions.md) &gt; [context](./foundation-testing.fixtureoptions.context.md)
-
-## FixtureOptions.context property
-
-The execution context to use during binding.
-
-**Signature:**
-
-```typescript
-context?: ExecutionContext;
-```

package/docs/api/foundation-testing.fixtureoptions.designsystem.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FixtureOptions](./foundation-testing.fixtureoptions.md) &gt; [designSystem](./foundation-testing.fixtureoptions.designsystem.md)
-
-## FixtureOptions.designSystem property
-
-A pre-configured design system instance used in setting up the fixture.
-
-**Signature:**
-
-```typescript
-designSystem?: DesignSystem;
-```

package/docs/api/foundation-testing.fixtureoptions.document.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FixtureOptions](./foundation-testing.fixtureoptions.md) &gt; [document](./foundation-testing.fixtureoptions.document.md)
-
-## FixtureOptions.document property
-
-The document to run the fixture in.
-
-**Signature:**
-
-```typescript
-document?: Document;
-```

package/docs/api/foundation-testing.fixtureoptions.md

@@ -1,134 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FixtureOptions](./foundation-testing.fixtureoptions.md)
-
-## FixtureOptions interface
-
-Options used to customize the creation of the unit test fixture.
-
-**Signature:**
-
-```typescript
-export interface FixtureOptions 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[context?](./foundation-testing.fixtureoptions.context.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ExecutionContext
-
-
-</td><td>
-
-_(Optional)_ The execution context to use during binding.
-
-
-</td></tr>
-<tr><td>
-
-[designSystem?](./foundation-testing.fixtureoptions.designsystem.md)
-
-
-</td><td>
-
-
-</td><td>
-
-DesignSystem
-
-
-</td><td>
-
-_(Optional)_ A pre-configured design system instance used in setting up the fixture.
-
-
-</td></tr>
-<tr><td>
-
-[document?](./foundation-testing.fixtureoptions.document.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Document
-
-
-</td><td>
-
-_(Optional)_ The document to run the fixture in.
-
-
-</td></tr>
-<tr><td>
-
-[parent?](./foundation-testing.fixtureoptions.parent.md)
-
-
-</td><td>
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-_(Optional)_ The parent element to append the fixture to.
-
-
-</td></tr>
-<tr><td>
-
-[source?](./foundation-testing.fixtureoptions.source.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-_(Optional)_ The data source to bind the HTML to.
-
-
-</td></tr>
-</tbody></table>
-