profectus-docs/assets/api_features_reset_functions_createReset.md.IBXO3Qi1.lean.js

1 line
3.1 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 t,c as a,a0 as o,o as r}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Function: createReset()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/reset/functions/createReset.md","filePath":"api/features/reset/functions/createReset.md","lastUpdated":null}'),s={name:"api/features/reset/functions/createReset.md"};function c(n,e,i,d,p,l){return r(),a("div",null,e[0]||(e[0]=[o('<p><a href="./../../../">Profectus</a> / <a href="./../">features/reset</a> / createReset</p><h1 id="function-createreset" tabindex="-1">Function: createReset() <a class="header-anchor" href="#function-createreset" aria-label="Permalink to &quot;Function: createReset()&quot;"></a></h1><blockquote><p><strong>createReset</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <code>object</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, <code>&quot;thingsToReset&quot;</code> | <code>&quot;onReset&quot;</code>&gt;, keyof <a href="./../interfaces/ResetOptions"><code>ResetOptions</code></a>&gt; &amp; <code>object</code></p></blockquote><p>Lazily creates a reset with the given options.</p><h2 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type Parameters&quot;"></a></h2><p>• <strong>T</strong> <em>extends</em> <a href="./../interfaces/ResetOptions"><code>ResetOptions</code></a></p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="optionsfunc" tabindex="-1">optionsFunc <a class="header-anchor" href="#optionsfunc" aria-label="Permalink to &quot;optionsFunc&quot;"></a></h3><p>() =&gt; <code>T</code></p><p>Reset options.</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><code>object</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, <code>&quot;thingsToReset&quot;</code> | <code>&quot;onReset&quot;</code>&gt;, keyof <a href="./../interfaces/ResetOptions"><code>ResetOptions</code></a>&gt; &amp; <code>object</code></p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/reset.ts#L46" target="_blank" rel="noreferrer">profectus/src/features/reset.ts:46</a></p>',14)]))}const f=t(s,[["render",c]]);export{u as __pageData,f as default};