chore(webapp): document functions

This commit is contained in:
Ahmed Bouhuolia
2023-08-20 23:16:54 +02:00
parent d5decbbd0b
commit abc5631ac2
3 changed files with 8 additions and 10 deletions

View File

@@ -18,8 +18,8 @@ export const getDefaultARAgingSummaryQuery = () => {
asDate: moment().endOf('day').format('YYYY-MM-DD'),
agingDaysBefore: 30,
agingPeriods: 3,
customersIds: [],
filterByOption: 'without-zero-balance',
customersIds: [],
branchesIds: [],
};
};
@@ -56,6 +56,7 @@ const parseARAgingSummaryQuery = (locationQuery) => {
return {
...transformed,
branchesIds: castArray(transformed.branchesIds),
customersIds: castArray(transformed.customersIds),
};
};

View File

@@ -7,6 +7,9 @@ import { useAppQueryString } from '@/hooks';
import { getDefaultARAgingSummaryQuery } from '../ARAgingSummary/common';
import { transformToForm } from '@/utils';
/**
* Default query of customers balance summary.
*/
export const getDefaultCustomersBalanceQuery = () => {
return {
asDate: moment().endOf('day').format('YYYY-MM-DD'),
@@ -27,7 +30,6 @@ export const getCustomersBalanceQuerySchema = () => {
/**
* Parses the customer balance summary query.
* @returns
*/
const parseCustomersBalanceSummaryQuery = (locationQuery) => {
const defaultQuery = getDefaultARAgingSummaryQuery();
@@ -38,15 +40,12 @@ const parseCustomersBalanceSummaryQuery = (locationQuery) => {
};
return {
...transformed,
//
customersIds: castArray(transformed.customersIds),
};
};
/**
*
* @returns
* Getter/setter query state of customers balance summary.
*/
export const useCustomerBalanceSummaryQuery = () => {
const [locationQuery, setLocationQuery] = useAppQueryString();

View File

@@ -3,8 +3,7 @@ import intl from 'react-intl-universal';
import moment from 'moment';
/**
*
* @returns
* The validation schema of vendors transactions.
*/
export const getVendorTransactionsQuerySchema = () => {
return Yup.object().shape({
@@ -17,8 +16,7 @@ export const getVendorTransactionsQuerySchema = () => {
};
/**
*
* @returns {}
* Retrieves the default query of vendors transactions.
*/
export const getVendorsTransactionsDefaultQuery = () => ({
fromDate: moment().toDate(),