Global - Documentation

Members

categoryTableComponent :CategoryTableComponent

Source:

frontend/products/products.js, line 183

Type:

CategoryTableComponent

clientsTableComponent :ClientsTableComponent

Source:

frontend/users/users.js, line 149

Type:

ClientsTableComponent

(constant) CRUD

Source:

database/CRUD.js, line 2

Consultas SQL hacia la BD

(constant) homeComponent :HomeComponent

Source:

frontend/home/home.js, line 166

Type:

HomeComponent

modalClientComponent :ModalClientComponent

Source:

frontend/orders/orders-form/orders-form.js, line 659

Type:

ModalClientComponent

modalProductsComponent :ModalProductsComponent

Source:

frontend/orders/orders-form/orders-form.js, line 662

Type:

ModalProductsComponent

mysqlAPI :mysql.Connection|null

Source:

database/database.js, line 9

API de mysql

Type:

mysql.Connection | null

(constant) ordersForm :OrdersForm

Source:

frontend/orders/orders-form/orders-form.js, line 667

Type:

OrdersForm

(constant) ordersTableComponent :OrdersTableComponent

Source:

frontend/orders/orders.js, line 267

Type:

OrdersTableComponent

(constant) productsComponent :ProductsComponent

Source:

frontend/products/products.js, line 174

Type:

ProductsComponent

productsTableComponent :ProductsTableComponent

Source:

frontend/products/products.js, line 179

Type:

ProductsTableComponent

(constant) profileModalComponent :ProfileModalComponent

Source:

frontend/home/home.js, line 169

Type:

ProfileModalComponent

(constant) reportsComponent :ReportsComponent

Source:

frontend/reports/reports.js, line 606

Type:

ReportsComponent

(constant) usersComponent :UsersComponent

Source:

frontend/users/users.js, line 139

Type:

UsersComponent

usersTableComponent :UsersTableComponent

Source:

frontend/users/users.js, line 142

Type:

UsersTableComponent

Methods

createWindow()

Source:

index.js, line 19

funcion principal para crear la ventana principal de electronJS

getPaginationStorage(key) → {Array.<number>}

Source:

frontend/global.js, line 55

Permite obtener el arreglo de elementos paginados

Example

let pagination = getPaginationStorage('usersTable');

Parameters:

Name	Type	Description
`key`	string	propiedad de donde extraer la paginacion

Returns:

Type: Array.<number>

getUserLogged()

Source:

frontend/global.js, line 36

Obtiene la instancia del usuario logueado

hideElement(element)

Source:

frontend/global.js, line 5

permite ocultar elementos del DOM

Parameters:

Name	Type	Description
`element`	HTMLElement	elemento html a ocultar

initMainMenu(dev)

Source:

user-interfaces/menu/menu.js, line 10

Funcion que inicializa el menu principal

Parameters:

Name	Type	Description
`dev`	boolean	entorno de desarrollo

redirectTo(path)

Source:

frontend/global.js, line 31

permite redireccionar a una url solicitada

Parameters:

Name	Type	Description
`path`	string	url a solcitar el recurso

renderErrors(element, message)

Source:

frontend/global.js, line 81

renderiza los errores en los formularios

Parameters:

Name	Type	Description
`element`	HTMLElement	elemento html
`message`	string	mensaje al usuario

setPaginationStorage(key, value)

Source:

frontend/global.js, line 71

establece una nueva paginacion

Parameters:

Name	Type	Description
`key`	string	propiedad de donde sustituir por el nuevo valor
`value`	Array.<number>	nuevo valor de paginacion

setUserLogged(user)

Source:

frontend/global.js, line 44

establece el usuario logueado de la applicacion

Parameters:

Name	Type	Description
`user`	User	instancia del usuario

showElement(element)

Source:

frontend/global.js, line 18

permite mostrar elementos del DOM

Parameters:

Name	Type	Description
`element`	HTMLElement	elemento html a mostrar

Type Definitions

callbackConsult(error, results)

Source:

database/database.js, line 45

Parameters:

Name	Type	Description
`error`	string \| Error \| null	error al insertar en la BD.
`results`	Array.<Object>	arreglo de objetos producto de la consulta

callbackDelete(error)

Source:

database/database.js, line 86

Parameters:

Name	Type	Description
`error`	string \| Error \| null	error al insertar en la BD.

callbackInsert(error)

Source:

database/database.js, line 21

Parameters:

Name	Type	Description
`error`	string \| mysql.MysqlError \| null	error al insertar en la BD.

callbackResponse() → {void}

Source:

controllers/notas-productos-controller.js, line 26

Returns:

Type: void

callbackUpdate(error)

Source:

database/database.js, line 72

Parameters:

Name	Type	Description
`error`	string \| Error \| null	error al insertar en la BD.

callbackValidateForm(error)

Source:

frontend/login/login.js, line 48

Parameters:

Name	Type	Description
`error`	boolean	flag que indica si existe un error en el formulario

Name	Type	Attributes	Description
`categoriaid`	number	<optional>	identificador de categoria
`userid`	number		identificador de usuario
`nombre`	string		nombre de la categoria
`activo`	boolean		flag si indica que la categoria esta disponible
`imagen`	string	<optional>	string base64 de la imagen

Source:

controllers/clientes-controller.js, line 1

Properties:

Name	Type	Attributes	Description
`id_cliente`	number	<optional>	identificador de cliente
`nombre_cliente`	string		nombre del cliente
`direccion_entrega`	string		direccion de entrega
`rif`	string		identificador de registro fiscal de cliente
`telefono_contacto`	string		telefono contacto del cliente

Client

Type:

Object

Nota

Source:

controllers/notas-controller.js, line 1

Properties:

Name	Type	Attributes	Description
`id_nota`	number		identificador de la nota
`id_cliente`	number		identificador de cliente
`userid`	number		identificador del usuario
`status`	"EN_PROCESO" \| "ACEPTADO" \| "ENTREGADA" \| "POSPUESTO" \| "CANCELADA"		estado de la orden en ese momento
`creacion`	string		timestamp de creacion de la nota
`descripcion_nota`	string		descripcion de la nota de entrega
`fecha_entrega`	string		fecha de entrega del pedido se completa si el usuario pasa el pedido a ENTREGADA
`productos`	Array.<NotaProducto>		lista de productos seleccionados
`total_order`	number	<optional>	total de la orden

Nota

Type:

Object

NotaProducto

Source:

controllers/notas-productos-controller.js, line 1

Properties:

Name	Type	Description
`id_NP`	number	identificador de notas_producto
`id_nota`	number	identificador de nota a que pertenece la relacion
`id_producto`	number	identificador de producto seleccionado
`cantidad_seleccionada`	number	cantidad seleccionada en la orden

NotaProducto

Type:

Object

Product

Source:

controllers/productos-controllers.js, line 1

Properties:

Name	Type	Attributes	Description
`productoid`	number	<optional>	identificador de producto
`userid`	number		identificador de usuario
`categoriaid`	number		identificador de categoria
`nombre`	string		nombre del producto
`descripcion`	string		descripcion de producto
`precio`	number		precio del producto
`cantidad`	number		cantidad de productos
`disponibilidad`	boolean		disponibilidad de producto

Product

Type:

Object

ResponseReport

Source:

controllers/reporte-controller.js, line 1

Properties:

Name	Type	Attributes	Description
`keys`	Array.<string>		listado de los nombres usados en el modelo estaditico
`values`	Array.<number>		listado de valores usados en el modelo estaditico
`results`	Array.<Object>		listado de la consulta para generar la tabla
`typeChart`	string		tipo de diagrama usado para generar los reporte
`name_consult`	string		nombre de la consulta
`buffer`	Uint8Array	<optional>	datos en bruto de la imagen, este campo se usa al dibujar en el PDF
`chart`	string	<optional>	imagen base64 del diagrama

ResponseReport

Type:

Object

setEvent()

Source:

frontend/home/profile-modal/profile-modal-component.js, line 70

User

Source:

controllers/users-controller.js, line 1

Properties:

Name	Type	Attributes	Description
`userid`	number	<optional>	identificador del usuario
`nombre`	string		nombre del usuario
`apellido`	string		apellido del usuario
`correo`	string		correo del usuario
`password`	string		contrasena del usuario
`password_confirmation`	string		confirmacion de contrasena

User

Type:

Object