update: Core Doc "JSDOC"

This commit is contained in:
RageServers 2020-08-04 11:33:14 +02:00
parent 3d9140d599
commit 31a82a6a80
3 changed files with 41 additions and 0 deletions

View File

@ -1,3 +1,18 @@
/**
*
* In this function it is the one that collects all the errors and then displays them by 'payload'
*
* @param {HTMLTableElement} Interface Helper - Interface Errors
* Checks if a character is in the control string
* @param {string} position
* @param {string} id
* @param {string} mode
* @param {string} element
* @param {string} NAH
* @return {void} Nothing
* @param {Array} payload - TThis element generates the errors
*/
// Reducers & helpers // Reducers & helpers
import { Swapper } from 'components/layout/Overlay/index.tsx' import { Swapper } from 'components/layout/Overlay/index.tsx'
import { useSelector } from 'umi'; import { useSelector } from 'umi';

View File

@ -1,5 +1,15 @@
/**
*
* Specify all core paths and export elements
*
* @param {HTMLTableElement} router - Archives Paths
*/
import { history } from 'umi'; import { history } from 'umi';
/**
* Specify the paths of the files, in this case it is pointing to the root
*/
export const router = { export const router = {
go: e => { go: e => {
goTo.element('primaryContent'); goTo.element('primaryContent');
@ -16,6 +26,9 @@ export const router = {
}, },
}; };
/**
* You are exporting the elements to collect errors
*/
export const goTo = { export const goTo = {
top: id => { top: id => {
const element = document.getElementById(id); const element = document.getElementById(id);

View File

@ -1,6 +1,18 @@
/**
*
* @param {HTMLTableElement} session - Callback / Credentials
* @returns {callback} make an API call to verify credentials
* @throws {NotFoundError} show error when credentials were not correctly put
* @async
*
*
*/
import endpoints from 'config/endpoints'; import endpoints from 'config/endpoints';
import { v3_model } from 'core/libs'; import { v3_model } from 'core/libs';
// @param {Array} payload callback - check the information and if it is correct give access
function auth(payload, callback) { function auth(payload, callback) {
if (!payload) return false; if (!payload) return false;
const { username, password, server_key } = payload; const { username, password, server_key } = payload;
@ -25,6 +37,7 @@ function auth(payload, callback) {
async function deauth() {} async function deauth() {}
// check the information and if it is correct give access
const backup = { const backup = {
get: () => {}, get: () => {},
set: () => {}, set: () => {},