Module
x/value_schema/src/adjusters/stringArray.es
simple, easy-to-use, and declarative input validator; supports Node.js, TypeScript, and Deno
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168import AdjusterBase from "../libs/AdjusterBase";
import Default from "../libs/decorators/default";import AcceptNull from "../libs/decorators/acceptNull";import AcceptEmptyString from "../libs/decorators/acceptEmptyString";import Type from "../libs/decorators/array/type";import MinLength from "../libs/decorators/array/minLength";import MaxLength from "../libs/decorators/array/maxLength";import Each from "../libs/decorators/stringArray/each";
/** * factory * @return {StringArrayAdjuster} adjuster object */export default () =>{ return new StringArrayAdjuster();};
/** * adjuster for array of string */@MaxLength@MinLength@Each@Type@AcceptEmptyString@AcceptNull@Defaultclass StringArrayAdjuster extends AdjusterBase{ /** * set default value; enable to omit * @method * @name StringArrayAdjuster#default * @param {string[]} value default value * @return {StringArrayAdjuster} */
/** * accept null * @method * @name StringArrayAdjuster#acceptNull * @param {?string[]} [value=null] value on null * @return {StringArrayAdjuster} */
/** * accept empty string * @method * @name StringArrayAdjuster#acceptEmptyString * @param {?string[]} [value=null] value on empty * @return {StringArrayAdjuster} */
/** * accept string and set separator * @method * @name StringArrayAdjuster#separatedBy * @param {string|String|RegExp} separator separator * @return {StringArrayAdjuster} */
/** * convert to array, if not * @method * @name StringArrayAdjuster#toArray * @return {StringArrayAdjuster} */
/** * set min-length of array elements * @method * @name StringArrayAdjuster#minLength * @param {int} length min-length; error if shorter * @return {StringArrayAdjuster} */
/** * set max-length of array elements * @method * @name StringArrayAdjuster#maxLength * @param {int} length max-length * @param {boolean} [adjust=false] truncate if longer; default is ERROR * @return {StringArrayAdjuster} */
/** * ignore each elements error * @method * @name StringArrayAdjuster#ignoreEachErrors * @return {StringArrayAdjuster} */
/** * set a default value for each elements * @method * @name StringArrayAdjuster#eachDefault * @param {?string} value default value * @return {StringArrayAdjuster} */
/** * remove whitespace from both ends for each elements * @method * @name StringArrayAdjuster#eachTrim * @return {StringArrayAdjuster} */
/** * accept null for each elements * @method * @name StringArrayAdjuster#eachAcceptNull * @param {?string} [value=null] value on null * @return {StringArrayAdjuster} */
/** * accept empty string for each elements * @method * @name StringArrayAdjuster#eachAcceptEmptyString * @param {?string} [value=null] value on empty * @return {StringArrayAdjuster} */
/** * accept only specified values for each elements * @method * @name StringArrayAdjuster#eachIn * @param {...string} values values to be accepted * @return {StringArrayAdjuster} */
/** * set min-length for each elements * @method * @name StringArrayAdjuster#eachMinLength * @param {int} length min-length; error if shorter * @return {StringArrayAdjuster} */
/** * set max-length for each elements * @method * @name StringArrayAdjuster#eachMaxLength * @param {int} length max-length * @param {boolean} [adjust=false] truncate if longer; default is ERROR * @return {StringArrayAdjuster} */
/** * specify acceptable pattern by regular expression for each elements * @method * @name StringArrayAdjuster#eachPattern * @param {string|String|RegExp} pattern acceptable pattern(regular expression); string or RegExp * @return {StringArrayAdjuster} */
/** * do adjust * @method * @name StringArrayAdjuster#adjust * @param {*} value value to be checked * @param {?AdjusterBase.OnError} [onError=null] callback function on error * @return {string[]} adjusted value */}