chore: document http query

This commit is contained in:
Ahmed Bouhuolia
2024-08-22 20:32:48 +02:00
parent 5749ccec81
commit d15fb6fe19
3 changed files with 8 additions and 9 deletions

View File

@@ -1,5 +1,5 @@
import { Request, Response, NextFunction } from 'express';
import { Container } from 'typedi'; import { Container } from 'typedi';
import { Request, Response, NextFunction } from 'express';
import SettingsStore from '@/services/Settings/SettingsStore'; import SettingsStore from '@/services/Settings/SettingsStore';
export default async (req: Request, res: Response, next: NextFunction) => { export default async (req: Request, res: Response, next: NextFunction) => {

View File

@@ -1,13 +1,12 @@
// @ts-nocheck // @ts-nocheck
import React from 'react'; import React from 'react';
import { useHistory } from 'react-router-dom';
import { Text } from '@blueprintjs/core';
import { Icon, For, FormattedMessage as T, Stack } from '@/components'; import { Icon, For, FormattedMessage as T, Stack } from '@/components';
import { getFooterLinks } from '@/constants/footerLinks'; import { getFooterLinks } from '@/constants/footerLinks';
import { useAuthActions } from '@/hooks/state'; import { useAuthActions } from '@/hooks/state';
import style from './SetupLeftSection.module.scss'; import style from './SetupLeftSection.module.scss';
import { Text } from '@blueprintjs/core';
import { Config } from '@/config'; import { Config } from '@/config';
import { useHistory } from 'react-router-dom';
/** /**
* Footer item link. * Footer item link.

View File

@@ -16,7 +16,7 @@ import {
import { setAuthLoginCookies } from './authentication'; import { setAuthLoginCookies } from './authentication';
import { batch } from 'react-redux'; import { batch } from 'react-redux';
interface CreateOneClickDemoValues {} interface CreateOneClickDemoValues { }
interface CreateOneClickDemoRes { interface CreateOneClickDemoRes {
email: string; email: string;
signedIn: any; signedIn: any;
@@ -24,7 +24,7 @@ interface CreateOneClickDemoRes {
} }
/** /**
* * Creates one-click demo account.
* @param {UseMutationOptions<CreateOneClickDemoRes, Error, CreateOneClickDemoValues>} props * @param {UseMutationOptions<CreateOneClickDemoRes, Error, CreateOneClickDemoValues>} props
* @returns {UseMutationResult<CreateOneClickDemoRes, Error, CreateOneClickDemoValues>} * @returns {UseMutationResult<CreateOneClickDemoRes, Error, CreateOneClickDemoValues>}
*/ */
@@ -41,7 +41,7 @@ export function useCreateOneClickDemo(
return useMutation<CreateOneClickDemoRes, Error, CreateOneClickDemoValues>( return useMutation<CreateOneClickDemoRes, Error, CreateOneClickDemoValues>(
() => apiRequest.post(`/demo/one_click`), () => apiRequest.post(`/demo/one_click`),
{ {
onSuccess: (res, id) => {}, onSuccess: (res, id) => { },
...props, ...props,
}, },
); );
@@ -50,10 +50,10 @@ export function useCreateOneClickDemo(
interface OneClickSigninDemoValues { interface OneClickSigninDemoValues {
demoId: string; demoId: string;
} }
interface OneClickSigninDemoRes {} interface OneClickSigninDemoRes { }
/** /**
* * Sign-in to the created one-click demo account.
* @param {UseMutationOptions<OneClickSigninDemoRes, Error, OneClickSigninDemoValues>} props * @param {UseMutationOptions<OneClickSigninDemoRes, Error, OneClickSigninDemoValues>} props
* @returns {UseMutationResult<OneClickSigninDemoRes, Error, OneClickSigninDemoValues>} * @returns {UseMutationResult<OneClickSigninDemoRes, Error, OneClickSigninDemoValues>}
*/ */