profectus-docs/assets/api_modules_features_reset.md.defaef04.js

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: features/reset","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/reset.md","lastUpdated":null}'),s={name:"api/modules/features/reset.md"},o=r('<h1 id="module-features-reset" tabindex="-1">Module: features/reset <a class="header-anchor" href="#module-features-reset" aria-label="Permalink to &quot;Module: features/reset&quot;">​</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><h3 id="basereset" tabindex="-1">BaseReset <a class="header-anchor" href="#basereset" aria-label="Permalink to &quot;BaseReset&quot;">​</a></h3><p>• <strong>BaseReset</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./reset#resetoptions">ResetOptions</a> to create an <a href="./reset#reset">Reset</a>.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>id</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;">An auto-generated ID for identifying which reset is being performed. Will not persist between refreshes or updates.</td></tr><tr><td style="text-align:left;"><code>reset</code></td><td style="text-align:left;"><code>VoidFunction</code></td><td style="text-align:left;">Trigger the reset.</td></tr><tr><td style="text-align:left;"><code>type</code></td><td style="text-align:left;">typeof <a href="./reset#resettype"><code>ResetType</code></a></td><td style="text-align:left;">A symbol that helps identify features of the same type.</td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/87a2d6b/src/features/reset.ts#L30" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:30</a></p><hr><h3 id="resetoptions" tabindex="-1">ResetOptions <a class="header-anchor" href="#resetoptions" aria-label="Permalink to &quot;ResetOptions&quot;">​</a></h3><p>• <strong>ResetOptions</strong>: <code>Object</code></p><p>An object that configures a Clickable.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>onReset?</code></td><td style="text-align:left;"><code>VoidFunction</code></td><td style="text-align:left;">A function that is called when the reset is performed.</td></tr><tr><td style="text-align:left;"><code>thingsToReset</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>unknown</code>&gt;[]&gt;</td><td style="text-align:left;">List of things to reset. Can include objects which will be recursed over for persistent values.</td></tr></tbody></table><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/87a2d6b/src/features/reset.ts#L20" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:20</a></p><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;">​</a></h2><h3 id="genericreset" tabindex="-1">GenericReset <a class="header-anchor" href="#genericreset" aria-label="Permalink to &quot;GenericReset&quot;">​</a></h3><p>Ƭ <strong>GenericReset</strong>: <a href="./reset#reset"><code>Reset</code></a>&lt;<a href="./reset#resetoptions"