A node.js module that provides a collection of ready-made functions used on large systems for their development.
This module was developed in node.js v10.16.3.
We recommend using node.js v10.x or higher.
This is a Node.js module available through the npm registry.
Installation is done using the npm install
command:
$ npm install --save jsoft-agile
or in development mode:
$ npm install --save-dev jsoft-agile
you can load this module like this:
const jagile = require("jsoft-agile");
or
const {wallFilters, ...} = require("jsoft-agile")
or like this:
import jagile from "jsoft-agile";
or
import {inObject, ...} from "jsoft-agile";
Faster and fully independent.
isName
check if the passed value is a name
Improvements: correctName
, isUsername
, inArrayAnyValue
, inObjectAnyProp
and removeArrayElements
isAll
check if all elements ofarray
aretypeof
passed
inArrayAnyValue
check if any value exists insidearray
inObjectAnyProp
check if any prop exists insideobject
hasValueAllProps
check if all props have valuegetTypeof
get type of value like "commonNumber, commonObject, array, function, etc..."wallFilters
validates or filters all data according to a rule
isString
check if the passed value is astring
isAllString
check if all elements of an array arestrings
isNumber
check if the passed value is anumber
isCommonNumber
checks if the passed value is acommonNumber
like "-1, 0, 1, 1.2, etc..."isAllCommonNumber
check if all elements of an array arecommonNumber
like "-1, 0, 1, 1.2, etc..."isBoolean
check if the passed value is aboolean
isAllBoolean
check if all elements of an array areboolean
isObject
check if the passed value is aobject
like "null, {}, etc..."isObjectId
check if the passed value is aobjectId
like "5db7e872dab3eb3d7cc44080"isAllObjectId
check if all elements of an array areobjectId
like "5db7e872dab3eb3d7cc44080isCommonObject
Check if the passed value is acommonObject
like "{}"isAllCommonObject
check if all elements of an array arecommonObject
like "{}"isArray
check if the passed value is anarray
isAllArray
check if all elements of an array arearray
isEmail
check if the passed value is anemail
isUsername
check if the passed value is ausername
like "joao99, jay99, jay, etc..."isPhoneNumber
check if the passed value is an international phone number like "+244 913 056 212, +555 555 1234"inArray
check if value exists insidearray
inObject
check if prop exists insideobject
hasValue
check if has some valuehasAllValues
check if all elements of an array has valuejustifySpaceWords
justify space between wordscapitalizeText
make the first letters of words capitalizedcheckMinValueEachWords
check the minimum amount of characters for each wordcheckMaxValueEachWords
check the maximum amount of characters for each wordcheckMinAndMaxValueEachWord
check the minimum and maximum amount of characters for each wordcorrectName
remove special characters and space except accentsgetArrayElements
getarray
elementsgetObjectProps
getobject
propsgetOnlyNumber
get only numbersgetElementPos
get the first position of anarray
ofobjects
by field and valuegenerateObjectId
generates a uniqueobjectId
like "5db7e872dab3eb3d7cc44080"removeArrayElements
removearray
elementsremoveObjectProps
removeobject
propertiesuniqueArray
remove repeated elements fromarray
uniqueArrayObjectBy
remove repeated elements from anarray
ofobjects
by propertyexistModule
check if there is a node.js module like "http, jsoft-agile, etc..."
37 functions ready for you
Check if the passed value is a string
. The return is boolean
.
isString: (value: any) => boolean
// example
console.log(jagile.isString("jay"));
> true
console.log(jagile.isString(19));
> false
console.log(jagile.isString({}));
> false
// and so on...
Check if all elements of an array
are string
. The return is boolean
.
isAllString: (values: array) => boolean
// example
console.log(jagile.isAllString(["jay", "trindade", "jsoft"]))
> true
// example - 2
let name = "João Trindade",
username = "joaotrindade.soft"
console.log(jagile.isAllString([name, username]))
> true
// example - 3
let stack = "MERN",
username = "jaytrindade",
id = 145678
console.log(jagile.isAllString([stack, username, id]))
> false
// example - 4
console.log(jagile.isAllString(["joão", 1, NaN, {}]))
> false
// and so on...
Check if the passed value is a number
. The return is boolean
.
isNumber: (value: any) => boolean
// example
console.log(jagile.isNumber(1));
> true
console.log(jagile.isNumber(NaN));
> true
console.log(jagile.isNumber("jay"));
> false
// and so on...
Checks if the passed value is a commonNumber
like "-1, 0, 1, 2.1, etc...". The return is boolean
.
isCommonNumber: (value: any) => boolean
// example
console.log(jagile.isCommonNumber(1));
> true
console.log(jagile.isCommonNumber(NaN));
> false
console.log(jagile.isCommonNumber("jay"));
> false
// and so on...
Check if all elements of an array
are commonNumber
like "-1, 0, 1, 2.1, etc...". The return is boolean
.
isAllCommonNumber: (values: array) => boolean
// example
console.log(jagile.isAllCommonNumber([-10, 20, 0, 1.2]))
> true
// example - 2
let age = 19,
id = 13456
console.log(jagile.isAllCommonNumber([age, id]))
> true
// example - 3
console.log(jagile.isAllCommonNumber([8, NaN, 50]))
> false
// example - 4
let name = "joão trindade",
id = 145678
console.log(jagile.isAllCommonNumber([name, id]))
> false
// and so on...
Check if the passed value is a boolean
. The return is boolean
.
isBoolean: (value: any) => boolean
// example
console.log(jagile.isBoolean(true));
> true
console.log(jagile.isBoolean(1));
> false
console.log(jagile.isBoolean("jay"));
> false
// and so on...
Check if all elements of an array
are boolean
. The return is boolean
.
isAllBoolean: (values: any) => boolean
// example
console.log(jagile.isAllBoolean([true, false]))
> true
// example - 2
let cool = true,
data = 100
console.log(jagile.isAllBoolean([cool, data]))
> false
// and so on...
Check if all elements of array
are typeof
passed. The return is boolean
.
isAll: (values: any, type: string) => boolean
// example
console.log(jagile.isAll([true, false], "boolean"))
> true
console.log(jagile.isAll([1, 2.1], "commonNumber"))
> true
console.log(jagile.isAll([1, "jay"], "string"))
> false
// and so on...
Check if the passed value is a object
. The return is boolean
.
isObject: (value: any) => boolean
// example
console.log(jagile.isObject({}));
> true
console.log(jagile.isObject([]));
> true
console.log(jagile.isObject(null));
> true
console.log(jagile.isObject(1));
> false
console.log(jagile.isObject("jay"));
> false
// and so on...
Check if the passed value is a objectId
like "5db7e872dab3eb3d7cc44080". The return is boolean
.
isObjectId: (value: any) => boolean
// example
console.log(jagile.isObjectId("5db7e872dab3eb3d7cc44080"));
> true
console.log(jagile.isObjectId([]));
> false
console.log(jagile.isObjectId(null));
> false
console.log(jagile.isObjectId(1));
> false
console.log(jagile.isObjectId("jay"));
> false
// and so on ...
Check if all elements of an array
are objectId
like "5db7e872dab3eb3d7cc44080. The return is boolean
.
isAllObjectId: (value: array) => boolean
// example
console.log(jagile.isAllObjectId(["5db7e872dab3eb3d7cc44080", "5db7e872dab3eb3d7cc44bcd"]))
> true
// example - 2
let obj1 = "5db7e872dab3eb3d7cc44080",
obj2 = "5db7e872dab3eb3d7cc44bcd"
console.log(jagile.isAllObjectId([obj1, obj2]))
> true
// example - 3
console.log(jagile.isAllObjectId([1, "Oops", {}]))
> false
// example - 4
console.log(jagile.isAllObjectId(["5db7e872dab3eb3d7cc44bcd", 1, false]))
> false
// and so on...
Check if the passed value is a commonObject
like "{}". The return is boolean
.
isCommonObject: (value: any) => boolean
// example
console.log(jagile.isCommonObject({}));
> true
console.log(jagile.isCommonObject([]));
> false
console.log(jagile.isCommonObject(null));
> false
console.log(jagile.isCommonObject(1));
> false
console.log(jagile.isCommonObject("jay"));
> false
// and so on...
Check if all elements of an array
are commonObject
like "{}". The return is boolean
.
isAllCommonObject: (value: any) => boolean
// example
console.log(jagile.isAllCommonObject([{name: "jay"}, {age: 20}, {}]))
> true
// example - 2
let obj1 = {day: "today"},
obj2 = {name: "soft"}
console.log(jagile.isAllCommonObject([obj1, obj2]))
> true
// example - 3
console.log(jagile.isAllCommonObject([1, "Oops", {}]))
> false
// example - 4
console.log(jagile.isAllCommonObject([["jay", "trindade"], 1]))
> false
// and so on..
Check if the passed value is an array
. The return is boolean
.
isArray: (value: any) => boolean
// example
console.log(jagile.isArray([]));
> true
console.log(jagile.isArray(["jay", "trindade"]));
> true
console.log(jagile.isArray({}));
> false
console.log(jagile.isArray(1));
> false
console.log(jagile.isArray("jay"));
> false
// and so on...
Check if all elements of an array
are array
. The return is boolean
.
isAllArray: (value: array) => boolean
// example
console.log(jagile.isAllArray([["jay"], [20], []]))
> true
// example - 2
let arr1 = ["some"],
arr2 = ["value"]
console.log(jagile.isAllArray([arr1, arr2]))
> true
// example - 3
console.log(jagile.isAllArray([1, "Oops", {}]))
> false
// example - 4
console.log(jagile.isAllArray([["jay", "trindade"], 1]))
> false
// and so on...
Check if the passed value is an email
. The return is boolean
.
isEmail: (value: any) => boolean
// example
console.log(jagile.isEmail("[email protected]"));
> true
console.log(jagile.isEmail("[email protected]"));
> true
console.log(jagile.isEmail("jay@gmail"));
> false
console.log(jagile.isEmail("jay"));
> false
// and so on...
Check if the passed value is a username
like "joao99, jay99, jay, etc...". The return is boolean
.
isUsername: (value: any, limitChar: ?number) => boolean
// example
console.log(jagile.isUsername("_joao99"));
> true
console.log(jagile.isUsername("@jay"));
> false
console.log(jagile.isUsername("12jay"));
> false
// and so on...
Check if the passed value is a correct name. The return is boolean
.
isName: (value: any) => boolean
// example
console.log(jagile.isName("Jay Trindade J'soft"));
> true
console.log(jagile.isName("João soft-dev J'soft"));
> true
console.log(jagile.isName("Jay 234 Soft"));
> false
console.log(jagile.isName("Jay Trindade jay_soft"));
> false
// and so on...
Check if the passed value is an international phone number like "+244 913 056 212, +555 555 1234". The return is boolean
.
isPhoneNumber: (value: any) => boolean
// example
console.log(jagile.isPhoneNumber("+244 913 056 212"));
> true
console.log(jagile.isPhoneNumber("555 555 1234"));
> false
// and so on...
Check if value exists inside array
. The return is boolean
.
inArray: (arr: array, values: string | array) => boolean
// example
let arr = ["jay", "trindade", 1, true, -4]
console.log(jagile.inArray(arr, ["jay", 1]));
> true
console.log(jagile.inArray(arr, -4));
> true
console.log(jagile.inArray(arr, [0, 1]));
> false
// and so on...
Check if any value exists inside array
. The return is commonObject
.
inArrayAnyValue: (arr: array, values: array) => commonObject
// example
let arr = ["jay", "trindade", 1, true, -4]
console.log(jagile.inArrayAnyValue(arr, ["jay", 1]));
> {ok: true, complete: true}
console.log(jagile.inArrayAnyValue(arr, [2, "trindade", "soft"]));
> {ok: true, complete: false, exist: ["trindade"], notExist: [1, "soft"]}
console.log(jagile.inArrayAnyValue(arr, [0, "soft", true]));
> {ok: false, complete: false}
// and so on...
Check if value exists inside object
. The return is boolean
.
inObject: (obj: commonObject, values: string | array) => boolean
// example
let obj = {id: 1, name: "jay", lastName: "trindade", age: 19}
console.log(jagile.inObject(obj, ["id", "name"]));
> true
console.log(jagile.inObject(obj, "sex"));
> false
console.log(jagile.inObject(obj, ["id", "sex"]));
> false
// and so on...
Check if any prop exists inside commonObject
. The return is commonObject
.
inObjectAnyProp: (obj: commonObject, values: array) => commonObject
// example
let obj = {id: 1, name: "jay", lastName: "trindade", age: 19}
console.log(jagile.inObjectAnyProp(obj, ["id", "name"]));
> {ok: true, complete: true}
console.log(jagile.inObjectAnyProp(obj, ["name", "country"]));
> {ok: true, complete: false, exist: ["name"], notExist: ["country"]}
console.log(jagile.inObjectAnyProp(obj, ["sex", "city", "state"]));
> {ok: false, complete: false}
// and so on...
Check if has some value. The return is boolean
.
hasValue: (value: any) => boolean
// example
console.log(jagile.hasValue("jay"));
> true
console.log(jagile.hasValue(1));
> true
console.log(jagile.hasValue(false));
> true
console.log(jagile.hasValue([]));
> false
console.log(jagile.hasValue({}));
> false
console.log(jagile.hasValue(null));
> false
// and so on...
Check if all elements of an array
has value. The return is boolean
.
hasAllValue: (values: array) => boolean
// example
console.log(jagile.hasAllValue(["jay", [20], true, -1]))
> true
// example - 2
let name = "jay",
age = 19
console.log(jagile.hasAllValue([name, age]))
> true
// example - 3
console.log(jagile.hasAllValue(["", "Oops", {}, []]))
> false
// and so on...
Check if all props have value. The return is commonObject
.
hasValueAllProps: (values: array) => commonObject
// example
let obj = {name: "jay", username:"soft", age: 19, sex: 1}
console.log(jagile.hasValueAllProps(obj, ["name", "username"]))
> {ok: true}
console.log(jagile.hasValueAllProps(obj, ["name", "city"]))
> {ok: false, except: ["city"]}
console.log(jagile.hasValueAllProps(obj, ["country", "city"]))
> {ok: false, except: ["country", "city"]}
// and so on...
Justify space between words. The return is string
.
justifySpaceWords: (value: string) => string
// example
console.log(jagile.justifySpaceWords("joão trindade"));
> joão trindade
// and so on...
Make the first letters of words capitalized. The return is string
.
capitalizeText: (value: string) => string
// example
console.log(jagile.capitalizeText("jOÃO tRiNdade jsoFt"));
> JOÃO tRiNdade jsoFt
console.log(jagile.capitalizeText("jOÃO tRiNdade jsoFt", true));
> JOÃO TRiNdade JsoFt
// and so on...
Check the minimum amount of characters for each word. The return is boolean
.
checkMinValueEachWords: (value: string, min: number) => boolean
// example
console.log(jagile.checkMinValueEachWords("joão de trindade", 2));
> true
console.log(jagile.checkMinValueEachWords("joão d trindade", 2));
> false
// and so on...
Check the maximum amount of characters for each word. The return is boolean
.
checkMaxValueEachWords: (value: string, max: number) => boolean
- max - a positive number
// example
console.log(jagile.checkMaxValueEachWords("jay soft", 5));
> true
console.log(jagile.checkMaxValueEachWords("joão trindade", 5));
> false
// and so on...
Check the minimum and maximum amount of characters for each word. The return is boolean.
checkMinAndMaxValue: (value: string, min: number, max: number) => boolean
- min > 0 and min < max
// example
console.log(jagile.checkMinAndMaxValueEachWord("jay soft", 2, 4));
> true
console.log(jagile.checkMinAndMaxValueEachWord("joão trindade", 5, 9));
> false
// and so on...
Remove special characters and space except accents. The return is string
.
correctName: (value: string) => string
// example
console.log(jagile.correctName("João980_$ 78 Tri_ndade J'soft"));
// joão Trindade J'soft
// and so on...
Get type of value. The return is typeof
.
getTypeof: (value: any) => "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "commonNumber" | "commonObject" | "objectId" | "array"
// example
console.log(jagile.getTypeof("jay"));
> "string"
console.log(jagile.getTypeof(1));
> "commonNumber"
console.log(jagile.getTypeof([]));
> "array"
console.log(jagile.getTypeof({}));
> "commonObject"
// and so on...
Get array elements. The return is array
.
getArrayElements: (arr: array, elements: any) => array
// example
let arr = ["jay", 19, true, "cool", -1, ...];
console.log(jagile.getArrayElements(arr, ["jay", -1]));
> ["jay", -1]
console.log(jagile.getArrayElements(arr, "jay"));
> ["jay"]
// and so on...
Get object props. The return is commonObject
.
getObjectProps: (obj: object, props: string | array) => object
// example
let obj = {id: 1, name: "jay", age: 19};
console.log(jagile.getObjectProps(obj, ["id", "age"]));
> {id: 1, age: 19}
console.log(jagile.getObjectProps(obj, "age"));
> {age: 19}
// and so on...
Get only numbers. The return is number
.
getOnlyNumber: (value: any) => number
// example
console.log(jagile.getOnlyNumber("jay 1df 34 soft"));
> 134
// and so on...
Get the first
position of an array
of objects
by field and value. The return is number
.
getElementPos: (arr: array, prop: string, value: any) => number
// example
let arr = [{name: "jay", age: 19}, {name: "soft", age: 20}, {name: "trindade", age: 19}]
console.log(jagile.getElementPos(arr, "name", "soft"));
> 1
console.log(jagile.getElementPos(arr, "id", "1"));
> -1
// and so on...
Generates a unique objectId
like "5db7e872dab3eb3d7cc44080". The return is objectId
.
generateObjectId: () => objectId
// example
console.log(jagile.generateObjectId());
> 5db7e872dab3eb3d7cc44080
// and so on...
Remove array
elements. The return is array
.
removeArrayElement: (arr: array, element: string | array) => array
// example
let arr = ["jay", 1, true, "soft"]
console.log(jagile.removeArrayElement(arr, ["jay", true]));
> [1, "soft"]
console.log(jagile.removeArrayElement(arr, 1);
> ["jay", true, "soft"]
// and so on...
Remove object
properties. The return is object
.
removeObjectProps: (obj: object, props: string | array) => object
// example
let obj = {name: "jay", age: 19, sex: 1, username: "joaotrindade.soft"}
console.log(jagile.removeObjectProps(obj, ["name", "sex"]));
> {age: 19, username: "joaotrindade.soft"}
console.log(jagile.removeObjectProps(obj, "username");
> {name: "jay", age: 19, sex: 1}
// and so on...
Remove repeated elements from array
. The return is array
.
uniqueArray: (arr: array) => array
// example
let arr = [1, 4, 2, "jay", 2, 4, true, "jay"];
console.log(jagile.uniqueArray(arr));
> [1, 4, 2, "jay", true]
// and so on...
Remove repeated elements from an array
of objects
by property. The return is array
.
uniqueArrayObjectBy: (arr: any, prop: string) => array
// example
let arr = [{name: "jay", age: 19}, {name: "soft", age: 20}, {name: "jay", age: 18}]
console.log(jagile.uniqueArrayObjectBy(arr, "name"));
> [{name: "jay", age: 19}, {name: "soft", age: 20}]
// and so on...
Check if there is a node.js module like "http, jsoft-agile, etc...". The return is boolean
.
existModule: (value: any) => boolean
// example
console.log(jagile.existModule("http"));
> true
console.log(jagile.existModule("jsoft-agile"));
> true
console.log(jagile.existModule("kkkkkk"));
> false
// and so on...
Validates or filters all data according to a rule. The return is commonObject
.
wallFilters: (data: commonObject) => commonObject
data: {
service: "string",
data: "commonObject",
rules: "commonObject",
validations: ?"function"
}
const rules = {
signup: {
fields: {
name: {
type: "string",
importantFields: ["username"],
validate: ["name", "username"]
},
username: { type: "string", validate: "username" },
sex: { type: "commonNumber", required: true, accepts: [1, 2] },
country: { type: "string", accepts: ["usa", "china"] },
state: { type: "string", needFields: ["country"] }
},
config: {
minFields: 3,
output: {
name: "Name",
username: "UserName",
sex: "Sex",
country: "Country",
state: "State"
}
}
}
};
/**
* field: {
* type: typeof,
* required: boolean,
* default: value,
* validate: string | array(string),
* importantFields: array(string),
* needFields: array(string),
* accepts: array
* }
*
* config: {
* minField: commonNumber,
* output: commonObject
* }
*/
module.exports = rules;
const jagile = require("jsoft-agile");
// validate name
const name = value => {
value = jagile.correctName(value);
if (jagile.checkMinAndMaxValueEachWord(value, 2, 8)) {
return { ok: true, value: value };
} else return { ok: false, message: "limit char" };
};
// validate username
const username = value => {
if (jagile.isUsername(value)) return { ok: true, value: value };
else return { ok: false, message: "invalid username" };
};
// all validates
const validate = data => {
let { type, value } = data;
if (type == "name") return name(value);
if (type == "username") return username(value);
return null
};
module.exports = validate;
const jagile = require("jsoft-agile");
const myRules = require("./rules");
const myValidations = require("./validates");
// example
console.log(
jagile.wallFilters({
service: "signup",
data: {
name: "jay trindade",
username: "jaytrindade",
age: 20,
sex: 1,
country: "usa"
},
rules: myRules,
validations: myValidations
})
);
>
{
ok: true,
exec: true,
data: {
Name: 'jay trindade',
UserName: 'jaytrindade',
Sex: 1,
Country: 'usa'
}
}
>
// example - 2
console.log(
jagile.wallFilters({
service: "signup",
data: {
name: "jay",
username: "@jay",
age: 19,
sex: 3,
country: "bbb"
},
rules: myRules,
validations: myValidations
})
);
>
{
ok: false,
exec: true,
errors: {
username: 'invalid username',
sex: 'Not allowed value',
country: 'Not allowed value'
},
keys: [
'username',
'sex',
'country'
]
}
>
// and so on...
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning.
João Trindade
- Email: [email protected]
- WhatsApp: +244 913 056 212
- Instagram: jayjsoft
This project is licensed under the MIT License
- I thank God for all the good you have done in my life
- To all those who supported me and always believed in me