profectus-docs/assets/api_features_challenges_challenge_functions_createActiveChallenge.md.Chsm-P-7.lean.js

1 line
2.4 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 a,c as t,a0 as l,o as r}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Function: createActiveChallenge()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/challenges/challenge/functions/createActiveChallenge.md","filePath":"api/features/challenges/challenge/functions/createActiveChallenge.md","lastUpdated":null}'),n={name:"api/features/challenges/challenge/functions/createActiveChallenge.md"};function c(o,e,i,s,h,d){return r(),t("div",null,e[0]||(e[0]=[l('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/challenges/challenge</a> / createActiveChallenge</p><h1 id="function-createactivechallenge" tabindex="-1">Function: createActiveChallenge() <a class="header-anchor" href="#function-createactivechallenge" aria-label="Permalink to &quot;Function: createActiveChallenge()&quot;"></a></h1><blockquote><p><strong>createActiveChallenge</strong>(<code>challenges</code>): <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a>&lt;<code>Challenge</code> | <code>null</code>&gt;</p></blockquote><p>Utility for taking an array of challenges where only one may be active at a time, and giving a ref to the one currently active (or null if none are active)</p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="challenges" tabindex="-1">challenges <a class="header-anchor" href="#challenges" aria-label="Permalink to &quot;challenges&quot;"></a></h3><p><code>Challenge</code>[]</p><p>The list of challenges that are mutually exclusive</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a>&lt;<code>Challenge</code> | <code>null</code>&gt;</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/challenges/challenge.tsx#L275" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:275</a></p>',12)]))}const g=a(n,[["render",c]]);export{f as __pageData,g as default};