profectus-docs/assets/api_interfaces_features_reset.BaseReset.md.2e8556d0.js

1 line
2.8 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as t,o as r,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseReset","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/reset.BaseReset.md","lastUpdated":null}'),s={name:"api/interfaces/features/reset.BaseReset.md"},i=a('<h1 id="interface-basereset" tabindex="-1">Interface: BaseReset <a class="header-anchor" href="#interface-basereset" aria-label="Permalink to &quot;Interface: BaseReset&quot;"></a></h1><p><a href="./../../modules/features/reset">features/reset</a>.BaseReset</p><p>The properties that are added onto a processed <a href="./reset.ResetOptions">ResetOptions</a> to create an <a href="./../../modules/features/reset#reset">Reset</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;"></a></h2><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;"></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying which reset is being performed. Will not persist between refreshes or updates.</p><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/70cda5f/src/features/reset.ts#L32" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:32</a></p><hr><h3 id="reset" tabindex="-1">reset <a class="header-anchor" href="#reset" aria-label="Permalink to &quot;reset&quot;"></a></h3><p>• <strong>reset</strong>: <code>VoidFunction</code></p><p>Trigger the reset.</p><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/70cda5f/src/features/reset.ts#L34" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:34</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to &quot;type&quot;"></a></h3><p>• <strong>type</strong>: typeof <a href="./../../modules/features/reset#resettype"><code>ResetType</code></a></p><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/reset.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:36</a></p>',21),n=[i];function o(d,f,c,h,p,l){return r(),t("div",null,n)}const _=e(s,[["render",o]]);export{b as __pageData,_ as default};