小程序函数手册
目前提供的前端表达式函数有字符串函数,日期时间函数相关常量,日期时间函数,编码函数,加密函数,数学函数,集合相关函数,随机数函数,运行环境函数及其他函数.
字符串函数
- 去除前后空格(字符串)
- 说明:此方法是清除字符串前后俩端的空白字符,
- 参数:
- 字符串类型
- 实例:
- 例如 " hellow " =》 "hellow" .
- 注意事项:
- 若手动输入请切记别忘了添加 “ ” 双引号包含所输入字符,绑定数据字段为字符串类型则不用添加双引号,此方法相当于JS里面的 trim()方法.
- 分割字符串(字符串,分隔符):
- 说明:用指定的元素分隔成字符串数组, 并对每个元素执行去除前后空格,相当于JS里面的字符串的 split() 方法.
- 参数:
- 字符串类型
- 分隔符,字符串类型,数字类型,空字符串.
- 返回值:
- 数组 [ ]
- 实例:
- ("abcde", "") =》 ["a","b","c","d","e"].
- ("a,b,c", ",") =》 ["a","b","c"].
是否为空文件(文件)
说明:此方法用于判定您所绑定的数据字段当前行的文件是否存在,如存在则返回true,空则返回false.
参数:文件类型.
转成字符串(值)
说明:此方法可以将数字类型,null,undefind转成字符串类型
参数:
数字类型
null
undefind
实例
例如 123 =》 “123”,
null和undefined 则转成空字符串 " " .
转成整数(字符串,默认值)
说明:此函数可解析一个字符串并返回一个整数,相当于JS里面的parseInt()方法.
注意:parseInt方法接受第二个参数(2到36之间),表示被解析的值的进制,返回该值对应的十进制数,而我们提供的方法默认转成10进制的整数,第二个参数的作用是转换后不是数字类型而是NAN的时候返回第二个参数来作为默认值.
参数:
{String} 第一个参数为字符串类型是必需的(要被解析的字符串).
{Any} 任意类型 参数第二个是默认值,如果第一个字符串转换后不是数字类型是NAN时,那么则返回您设置的第二个参数,也就是默认值.
实例:
只输入字符串 "10" 或者 "10aaaaaa" =》 都返回 10
2个参数都填写时 例如 "dasdae",2 =》返回 2 .
“aaaaa”,"bcd" =》 "bcd".
转成小数(字符串,默认值)
说明:此函数可解析一个字符串,并返回一个浮点数(小数).相当于JS的parseFloat()方法.
参数:
{String} 第一个参数为字符串类型是必需的(要被解析的字符串).
{Any} 任意类型 参数第二个是默认值,如果第一个字符串转换后不是数字类型是NAN时,那么则返回您设置的第二个参数,也就是默认值.
实例:
"2345.14" =》2345.14 .
"-.3 C" =》 -0.3 .
"-.213123abc,"abc" =》 -0.213123 .
"hellow","abc" =》 "abc".
数值转成字符串(数值,小数位数)
说明:此函数可将第一个参数传入的数值转换成保留第二个参数个数的浮点数,
参数:
数值类型 Number
数值类型 Number
实例
如 456 ,2 =》456.00
如 456.123,2 =》456.12
补零(字符串,长度,右补零)
- 说明:此函数是传入的字符串转成您想要长度的字符串,如长度不够,则会自动补0
- 参数:
- 字符串 string
- 数字类型 number
- 布尔值 Boolean,true是右边补零,false是左边补零.
- 实例:
- ("aa",5,true) =》 "aa000".
- (“aa”,5,false)=》"000aa" .
首字母大写(字符串)
说明:将含有应为字符的第一个英文字符大写.
参数:
- 字符串 string
实例:
- "abc" =》"Abc".
字符串截取(字符串,截取开始位置,截取结束位置)
说明:相当于JS的 substring() 方法,在传入字符串中截取从开始位置的值到截取结束位置的值中间的字符.
参数:
字符串 string
数字类型 Number
数字类型 Number
实例:
- "images/off_1.png" , 7,10 =》 "off" .
是否为空("字符串"),是否非空("字符串")
说明:这2个方法是判断当前传入字符串值是否有值来返回true或者false.
参数:
- 字符串 string
首字母小写(字符串)
说明:将传入字符串中含有英文字母的首个字符小写
参数:
- 字符串 string
实例:
- "ABC" =》 "aBC" .
转为小写(字符串)
说明:将接受参数的字符串中所有的英文字母都转成小写.
参数:
- 字符串 string
实例:
- “ABC”=》"abc".
转成大写(字符串)
说明:将接受参数的字符串中所有的英文字母都转成大写.
参数:
- 字符串 string
实例:
- 例:"abc" =》"ABC".
是否包含指定字符串(字符串,包含的字符串)
说明:此函数作用是在一个字符串中查找是否包含某一个字符串,包含就返回true,不包含返回false.
参数:
字符串 string
字符串 string 第二个字符串是包含的字符串
实例:
("abcdefghj","def")返回true .
("abcdefghj","opqrst")返回false.
查找首次出现位置(字符串,查找的字符串)
说明:返回从第一个参数的字符串中找第二个参数字符串首次出现的索引值,没有则返回 -1
参数:
字符串 string
字符串 string 想查找的字符串
实例 :
"abcb","b" 则返回1,
“abcb”,“e” 则未找到则返回-1
查找末次出现位置(字符串,查找的字符串)
说明:返回的是参数2在参数1中最后一次出现位置的索引值,没有返回-1.
参数:
字符串 string
字符串 string 想查找的字符串
实例:
- "abcb","b" 则返回3 . 字符串中存在2个“b” ,查找的最后的 b
以指定字符串开始(字符串,指定的字符串)
说明:判断一个字符串是否是已某个指定的字符串开头的字符串,返回值是Boolean.
参数:
字符串 string
字符串 string
实例:
"abc","a" 返回true.
"abc","b" 返回false.
以指定字符串结束(字符串,指定的字符串)
说明:判断一个字符串是否是已某个指定的字符串结束,返回值是Boolean.
参数:
字符串 string
字符串 string
实例
- "abc","bc" 返回true,"abc","cd" 返回false.
是否为数字(字符串)
说明:判断一个字符串是否里面字符都是由数字组成的.返回Boolean
参数:
- 字符串
实例:
传入字符串如果为"abcde"则返回false.
如果“1234”则返回true.
字符串替换(字符串,查找字符串,替换字符串)
说明:此函数是将传入的参数1字符串中查找参数2,如果在参数1中查找到2,那么就会将参数3替换到参数2的位置.
参数:
字符串 string
字符串 string 查找的字符串
字符串 string 替换的字符串
实例:
- 如 “123a45”,"a","bcd" =》“123bcd45”.
日期时间函数及相关常量:
表达式编辑器中提供了日期时间相关常量,作用是配合日期时间函数使用,比如你想把当前的时间转换成您想要的日期格式显示的时候就可以配合使用实现.
相关常量的日期格式
时间格式1——格式 yyyy-MM-ddThh:mm:ss.fffz
实例:
- 2018-08-03T00:29:12.180Z
时间格式2——格式 yyyy/MM/dd hh:mm:ss
实例:
- 2018/08/03 00:29:12
时间格式3——格式 yyyy-MM-dd hh:mm:ss
实例:
- 2018-08-03 00:29:12
日期格式2——格式 yyyy/MM/dd
实例:
- 2018/08/03
日期格式1——格式 yyyy-MM-dd
实例:
- 2018-08-03
是否闰年(日期)
说明:判断当前传入日期的年份是否是闰年,返回布尔值。
参数:
- 日期 或者日期时间 Date
闰年的含义:
- 阳历有闰日(即2月有29日)的年份叫闰年,这年是366天。农历有闰月的年份(即一年有13个月)叫闰年,这年是384天或385天。是就返回true, 不是就返回false.
时间间隔函数(开始时间,结束时间,时间单位):
说明:开始时间和结束时间接受一个日期类型的参数,时间单位在日期时间相关的常量里选择以年或者月或者日后者小时为单位计算开始时间和结束日期时间的间隔数。
参数:
日期或者日期时间 Date 开始时间
日期或者日期时间 Date 结束时间
时间单位 此参数在日期函数的相关常量中选择,分为年,月,日,小时等单位的值。
实例:
- (2018-8-14,2018-8-16,时间日期天),那么就会返回 2 (天).
关于日期函数和相关常量的使用说明
在提供的日期函数中参数基本分为三种 时间和时间格式,单位,时间代表着日期格式类型的数据,时间格式和单位都是在日期函数的相关常量中选择填入.
在使用时间转成字符串函数和字符串转成时间俩个函数时,这里说明一下 时间转成字符串就是 例如 2018-14-12=》 “2018-14-12” ,俩种是不一样的 ,使用时请注意.
编码函数:
base64编码(字符串):
说明:此方法接收一个字符串进行base64编码.
参数:
- 字符串 string
作用及使用场景:
- Base64主要用于将不可打印的字符转换成可打印字符,或者简单的说将二进制数据编码成ASCII字符,可用于电子邮件,XML文件,图片转成Base64码的使用场景.
base64解码(字符串):
说明:base64码是可以逆向转换回来的.传入个base64字符串解码成字符.
参数:字符串 string
URl解码以及编码(字符串):
参数:
- 字符串 string
作用及使用场景:
- url 未编码时 例如http://www.newdao.net, 进行编码后就会产生一个类似http://www.newdao.net.cn/My first/,/?:@&=+$#, 当你使用get方法传输数据时,而且传输的数据中包含中文、符号等字符时,可以使用encode进行编码。
其他函数:
生成唯一码():
说明:返回UUID字符串,你可以理解当你使用场景一个元素需要唯一ID或者创建一个唯一ID的用户的时候就可以使用这个方法生成一个唯一的值.
实例: 生成的值如下:C8162D89C7600001C62525E05B9016C8.
条件判断(判断的条件,满足条件时的返回值,不满足条件的返回值):
说明:根据传入的判断返回不同的Boolean值,true则返回传入的第二个参数值,false则返回第三个参数的值.
参数:
第一个参数为某种值产生的判断条件,例如 “2”==2,也可以直接传入一个变量a,若a存在则返回true.
第二个参数为满足条件返回的值,可以是任意类型。
第三个参数为不满足条件返回的值,可以是任意类型.
实例:
- 例如 if(a==b){return c}else{return d} ,就是如果 变量a 和变量b的值相同则返回 c 否则 返回 d.
是否布尔类型(值):
说明:此函数判断您传入的参数值的类型是否是布尔类型(true , false),是就返回true,不是就返回false.
参数:
- 任意类型的值
实 例 :
(ture) =》 true
("true") =》false .
是否是字符串类型(值):
说明:此函数判断您传入的参数值是否是字符串类型,如果是字符串返回ture,其他类型如数字,布尔,数组对象则返回false,
参数:
- 任意类型的值例
实例:
如 ("hellow") =》 true ,
([1,2]) =》 false .
是否函数(值):
说明: 此函数判断传入的参数值是否是一个函数(function(){}),返回布尔值.
参数:
- 任意类型的值
实例:
(function getValue(){}) =》 true
("abcd") =》 false.
是否数组(值):
说明:此函数判断传入参数是否是一个数组类型([1,2,3]),返回布尔值.
参数:
- 任意类型的值
实例:
(["a","b",2,4]) =》 true.
("bcd") =》 false .
是否对象(值):
说明:此函数判断传入参数是否是一个对象类型({name:"john",age:18}),返回布尔值.
参数:
- 任意类型的值
实例:
({key:"appID",value:123456}) =》 true.
(123456) =》 false.
整数格式检查(值):
说明:此函数判断接收的字符串是否是一个整数类型.
参数:
- {String} 字符串
返回值:
- {Blooean} 布尔类型
实例:
(“123456”)=》 true .
("1.23456") =》 false .
("1a2345") =》 false.
数值格式检查(值):
说明:此函数判断接收的字符串是否是数值类型,整数或者浮点数都可以.
参数:
- {String}
返回值:
- {Blooean}
实例:
(“123456”) =》 true.
("1.23456") =》 true.
字符长度检查(值,最小长度,最大长度):
此函数判断接收的字符串是否在指定的长度范围内.
参数:
{String}
{Integer} min 最小长度 为-1时表示不限制
{Integer} max 最大长度 为-1时表示不限制
返回值:
- {Boolean}
实例:
(“123456”,2,6) =》 true.
("123456",-1,-1) =》 true.
("123456",-1,3) =》 false.
加密函数:
MD5加密(需要加密的字符串):
- 说明:此函数可以对传入的字符串进行MD5加密.
- 参数:字符串 string
- 实例:
- ("abcd1234") =》 e19d5cd5af0378da05f63f891c7467af
- 作用以及使用场景:
- MD5中文名为消息摘要算法第五版,为计算机安全领域广泛使用
的一种散列函数,用以提供消息的完整性保护. - 一般是将用户输入的密码使用md5加密之后,再传回服务器,好处是密码在前端进行加密,然
- MD5中文名为消息摘要算法第五版,为计算机安全领域广泛使用
后服务器使用摘要进行比对,这样在整个密码的校验过程中是在服务器端不知道明码的情况下进行的,极大的保证了密码的安全.
- 在避免文件内容被篡改方面有重大作用,md5可以对字符串进行不可逆的加密,这使得可以生成一个128bit的大数,由于md5算法的原因,他与源文件相对应,即使在文件中做了很小的修改,那么生成的字符串也是差别巨大.
数学函数:
- 绝对值(数值):
- 说明:此函数方法是将传入参数的数值取绝对值,相当于JS中的 Math.abs() .
- 参数:
- 数值 Number
- 实例:
- (7.25) =》 7.25
- (-7.25) =》 7.25
- (7.25-10)=》 2.75.
向上取整(数值):
- 说明:此函数方法用于对数值向上取整,即得到大于或等于该数值的最小整数,相当于JS中的Math.ceil()方法.
- 参数:
- 数值 Number
实例:
- (0.35) =》 1
- (-10.1) =》 -10.
(10)=》 10.
向下取整(数值):
说明:此函数方法用于对数值向下取整,即得到小于或等于该数值的最大整数,相当于JS中的Math.floor()方法.
参数:
- 数值 Number
实例:
(-10.1) =》 -11 .
(0.35) =》 0.
(10)=》10.
最大值(数值1,数值2),最小值(数值1,数值2):
说明:这2个函数方法相当于一个比较函数,根据大小返回其中的一个值.
参数:
数值 Number
数值 Number
四舍五入(数值):
说明:此函数方法将传入数值进行四舍五入后返回.相当于JS中的Math.round()方法.
参数:
- 数值 Number
实例:
(0.7512) =》 1
(0.32154)=》0
保留小数位数(数值,小数个数):
说明:此函数方法返回保留小数位数值四舍五入后的结果.
参数:
数值 Number
数值 Number 正整数
实例:
(5.32415,2) =》 5.32
(5.3281245,2)=》5.33 .
平方根(数值):
说明:此函数方法返回传入值的平方根,平方根又叫二次方根,表示为〔±√ ̄〕.
参数:数值 Number
实例:
- (4) =》 2
集合相关函数:
- 是否包含元素(集合,元素):
- 说明:此方法用来判断一个数组集合中是否包含某一指定元素.
- 参数:
- {Array} 集合
- {Any} 元素 任意类型
- 返回值:
- {Boolean} 布尔类型
- 实例:
- ([1,2,3] , 1) =》 true.
- ([1,2,3] , 4)=》 false.
- 是否空集合(集合):
- 说明:此方法用来判断一个数组集合是否是一个空数组.
- 参数:
- {Array} 集合
- 返回值:
- {Boolean} 布尔类型
- 实例:
- ([1,2]) =》 false.
- ([ ]) =》 true.
- 是否为非空集合(集合):
- 说明:此方法用来判断一个数组集合是否是一个非空数组.
- 参数:
- {Array} 集合
- 返回值:
- {Boolean} 布尔类型
- 实例:
- ([1,2]) =》 true .
- ([ ]) =》 false.
- 集合元素数(集合):
- 说明:此方法用来获取一个数组集合中包含几个元素.
- 参数:
- {Array} 集合
- 返回值:
- {Integer} 数字类型 整数
- 实例:
- ([1,2,3]) =》 3.
- ([ ]) =》 0.
- 集合最大元素(集合):
- 说明:此方法用来获取一个数组集合中值最大的那个元素并返回这个元素.
- 参数:
- {Array} 集合
- 返回值:
- {Any} 任意类型
- 实例:
- ([1,2,3]) =》 3.
- 集合最小元素(集合):
- 说明:此方法用来获取一个数组集合中值最小的那个元素并返回这个元素.
- 参数:
- {Array} 集合
- 返回值:
- {Any} 任意类型
- 实例:
- ([1,2,3])=》 1 .
- 集合第一个元素(集合):
- 说明:此方法用来获取一个数组集合中首个(第一个)元素并返回这个元素
- 参数:
- {Array} 集合
- 返回值:
- {Any} 任意类型,空数组时返回undefind.
- 实例:
- (["a","b","c"]) =》 “a” .
- 集合最后一个元素(集合):
- 说明:此方法用来获取一个数组集合中最后一个元素并返回这个元素.
- 参数:
- {Array}集合
- 返回值:
- {Any} 任意类型,空数组时返回undefind.
- 实例:
- (["a","b","c"]) =》 "c" .
- 集合元素(集合,索引):
- 说明:此方法用来获取一个数组集合中指定索引元素并返回这个元素.
- 参数:
- {Array} 集合
- {Integer} 索引 整数
- 返回值:
- {Any} 任意类型
- 实例:
- (["a","b","c"], 1) =》 "b" .
随机数函数:
随机整数(长度):
说明:此函数方法随机产生一个根据您传入参数的值长度的整数.
参数:
- 数值 Number 正整数
实例:
(5)=》 12345
(10)=》 1234567890
随机小数():
说明:此函数方法随机产生一个0~1之间的小数,不包含1.,相当于JS里的 Math.random()方法.
参数:无 无需传入
实例:
- 调用后生成0.5887429589259408 .
随机字符串(长度):
- 说明:提供了3种随机字符串的方法,根据您传入数值的长度随机生成一个字母和数字混合的或者单纯都是字母的或者都是数字组成字符串.
- 参数:
- 数值 Number 正整数
- 实例:
- (5)=》 a1b5c
- (5) =》 abcde
- (5) =》 12345
运行环境函数:
- 是否是X5App环境():
- 说明:调用此函数会判断您当前程序所处的运行环境是否在X5APP环境,返回布尔值。X5App环境代表是您打包发布在手机上的APP运行环境.
- 是否是小程序环境():
- 说明:调用此函数会判断您当前程序所处的运行环境是否在小程序环境,返回布尔值。小程序环境包括小程序开发工具或者测试和正式发布后在手机微信中运行的环境.
- 是否在浏览器环境():
- 说明:调用此函数会判断您当前程序所处的运行环境是否在浏览器环境,返回布尔值。浏览器环境为经过测试或者正式发布后在PC端预览或者运行的环境.
- 是否在模拟环境中():
- 说明:调用此函数会判断您当前程序所处的运行环境是否在模拟环境,返回布尔值。模拟环境为未经过测试或者正式发布直接预览打开的环境为模拟环境.
字符串校验函数:
- 判断是否为手机号(字符串):
- 说明:此方法可以判断当前接收的字符串是否符合是手机号类型规则的字符串.
- 参数:
- 字符串.
- 返回值:
- 布尔值 true ,false
- 实例:
- (“17710512252”) = 》 true .
- ("184453asaa") =》 false .
- 判断是否为电子邮箱(字符串):
- 说明:此方法可以判断当前接收的字符串是否符合是电子邮箱类型规则的字符串.
- 参数:
- 字符串.
- 返回值:
- 布尔值 true ,false
- 实例:
- (“44587155@qq.com”)=》 true .
- ("das11266.qwerdas.com") = 》 false.
- 判断是否为身份证号码(字符串):
- 说明:此方法可以判断当前接收的字符串是否符合是身份证类型规则的字符串.
- 参数:
- 字符串.
- 返回值:
- 布尔值 true,false
- 实例:
- ("230208198605132121") =》 ture .
- ("1231513251231") = 》false.