easy-api.ts/lib/functions/array/arrayRemove.js

A powerful library to create your own API with ease.

Object.defineProperty(exports,"__esModule",{value:!0});let Error_1=require("../../classes/structures/Error"),APIFunction_1=require("../../classes/structures/APIFunction"),Util_1=require("../../classes/internal/Util");class ArrayRemove extends APIFunction_1.APIFunction{name="$arrayRemove";description="Removes the provided array element by its index.";parameters=[{name:"Name",description:"The name of the array.",type:APIFunction_1.ParamType.String,required:!0,rest:!1,defaultValue:null},{name:"Index",description:"Element index to be removed.",type:APIFunction_1.ParamType.Number,required:!0,rest:!1,defaultValue:null}];usage="$arrayRemove[name;index]";returns=APIFunction_1.ParamType.String;aliases=[];compile=!0;async run(e,[r,n]){var a=Util_1.Util.parseArrayLike(r),t=e.internalVarExists("NodeJS.Arrays:"+r),i=null===a;if(i&&!t)throw new Error_1.InvalidVariableName(Error_1.VariableType.Array,r,e.function);if(i=i||t?e.getInternalVar("NodeJS.Arrays:"+r):a,!Util_1.Util.isNumber(n)||Number(n)<1||Number(n)>i?.length)throw new Error_1.InvalidFieldIndex(n,e.function,"Element Index");return i.splice(Number(n)-1,1)[0]}}exports.default=ArrayRemove;