@ arrows/ 阵列
目录
导言
图书馆的目的是为下列人员提供功能性包装: Array.prototype methods 并为共同任务提供一些额外功能.
所有包装器都尝试尽可能地模仿原始方法,同时提供可堆叠的,自发的数组方法版本. 一个例外是,所有函数都不改变输入数组(甚至 sort, (中文(简体) ), reverse(见a/c.5/49/70,附件).
为方便起见,一些函数有额外的方法执行函数最常用的用例. 比如说.. sort 函数除通用形式外,还包含静态方法(这些方法也是自动驱动的,纯函数),例如: sort.num, (中文(简体) ), sort.numDesc等 (中文(简体) ).
没有本地等同功能 _ 后缀。 这样,我们就可以在未来实施类似本地的版本(如果语言中将添加一个等同的方法),而不会可能打破库的后向相容性.
图书馆有 内置类型定义,提供了极佳的IDE支持.
安装
通过国家预防机制:
npm i @arrows/array
维亚·亚恩:
yarn add @arrows/array
所有模块都可以独立导入(以减小捆绑大小),这里有一些导入方法(您可以使用普通JS或ES模块):
import arr from "@arrows/array"
import { filter } from "@arrows/array"
import filter from "@arrows/array/filter"
API 参考
指数
- 附录
- 但最后一点
- 块
- 清除( c)
- 弯曲
- 条目
- 每个
- 填满
- 全部填满
- 填充. 结束
- 填满 开始
- 过滤器
- 过滤器不为
- 寻找
- 查找Index 数据
- 首个
- 平顶
- 平一号
- 平方图
- 每个
- 获取
- 组
- 拥有
- 包含
- 索引
- 全部指数
- 插入
- 加入时
- 密钥
- 最后一个( l)
- 最后一个 索引
- 上个 IndexOf. all (简体中文)
- 地图
- 预设( p)
- 范围
- 减少
- 减. 第一个
- 减少右边
- 减少权利。 第一个
- 删除
- 暂停
- 倒转
- 设定
- 设置
- 大小
- 切开
- 切片 从
- 切开. to
- 有点
- 排序
- 排序.num
- 类型.numDesc
- 排序.str
- 类型.strDesc
- 类型
- 类型
- 排序为
- 排序为 .num
- 排序为 .numDesc
- 排序为 .str
- 排序为 .strDesc
- 排序为 . locale
- 排序为 . localeDesc
- 转到本地结构
- 倒数
- 更新
- 数值
- 拉链
- 全部拉链
- zipWith (帮助)
- zipWith .all (全称)
附录
在数组末尾添加一个值. 和Array.prototype.push类似,但不可改变.
参数
value额外价值arr初始阵列
回返情况: 新建阵列
但最后一点
从初始创建新数组,不包含最后一个元素.
参数
arr初始阵列
回返情况: 新建阵列
块
将数组分割成指定大小的块.
参数
chunkSize块大小arr初始阵列
回返情况: 新建块阵列
清除( c)
创建一个新的空数组.
参数
arr初始阵列
回返情况: 新建阵列
弯曲
Array.prototype.concat 的功能包装器
结合了两个阵列. 如果缩合值不是数组,则添加为最后一个元素.
参数
value要调整的数组或单个值arr初始阵列
回返情况: 新建阵列
条目
Array.prototype.intries 的功能包装器
为数组中的每个条目创建索引、值对.
参数
arr初始阵列
回返情况: 指数值对的可移动性
每个
Array.prototype 的功能包装
确定一个数组的所有成员是否都满足指定的测试.
参数
testFn测试函数arr初始阵列
回返情况: 如果所有元素都满足测试功能, 则不正确
填满
创建由起始和结束索引识别的段落的新数组 以所提供的数值填充. 对普通案件有内在的方法.
参数
startIndex开始索引( 如果未定义 - 从开始填充)endIndex结束索引( 如果未定义 - 填入到结尾)value将填入所选部分的值 .arr初始阵列
回返情况: 新建阵列
全部填满
从起入入入入入入入入.
参数
value将填入所选部分的值 .arr初始阵列
回返情况: 新建阵列
填充. 结束
从开始填入指定的索引.
参数
endIndex结束索引value将填入所选部分的值 .arr初始阵列
回返情况: 新建阵列
填满 开始
从指定的索引填入到结尾.
参数
startIndex开始索引value将填入所选部分的值 .arr初始阵列
回返情况: 新建阵列
过滤器
Array.prototype.filter 的功能包装器
从初始创建新数组, 不包含数值 不符合过滤函数中指定的条件.
参数
fn过滤功能arr初始阵列
回返情况: 新建阵列
过滤器不为
从初始创建新数组, 不包含数值 符合过滤函数中指定的条件.
当您拥有随时可以使用的过滤功能时,这是有用的, 你想通过作为一个争论, 否则你会有 手动将其包裹在函数中以否定其结果.
参数
fn过滤功能arr初始数组
回返情况: 新建阵列
寻找
Array.prototype. find 的功能包装器
获取数组中第一个元素的值 在上游是真实的, 和未定义的.
参数
testFn测试函数arr初始阵列
回返情况: 符合上游或未定义的项目
查找Index 数据
Array.prototype.findIndex 的功能包装器
获取数组中第一个元素的索引 -1,否则.
参数
testFn测试函数arr初始阵列
回返情况: 匹配元素索引或 - 1
首个
获取数组的第一个元素.
参数
arr初始阵列
回返情况: 第一个要素
平顶
带有自定义深度的 Array. prototype.平面的功能包装
创建一个包含所有子阵列元素的新阵列 相接而入,可递回至所指定的深度.
参数
depth最大重现深度arr初始阵列
回返情况: 新建阵列
平一号
带有默认深度的版本 (1).
参数
arr初始阵列
回返情况: 新建阵列
平方图
Array.prototype.flatMap 的功能包装器
调用数组每个元素上定义的映射函数. 然后,将结果平整成新的数组. 这与一幅地图相同,后面是平地,深度为一.
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
每个
Array.prototype.forEach 的功能包装器
为数组中的每个元素执行指定的副作用动作.
参数
sideEffectFn边效应函数arr初始阵列
回返情况: 无( 未定义)
获取
获取特定索引中的元素.
参数
index具体指数
回返情况: 特定索引中的元素
组
创建将数组项目分组的对象 通过分组函数指定字段.
参数
groupingFn分组函数arr对象初始数组
回返情况: 新建阵列
拥有
确定数组是否有一定索引, 酌情归还真假.
参数
index具体指数arr初始阵列
回返情况: 如果索引存在, 则不正确
包含
确定一个数组是否包含某个元素, 酌情归还真假.
参数
element搜索元素arr初始阵列
回返情况: 如果元素存在, 则不正确
索引
Array.prototype.indexOf 的功能包装器
检索数组中第一个值出现的索引.
参数
element在数组中定位的值fromIndex开始搜索的数组索引arr初始阵列
回返情况: 匹配元素索引或 - 1
全部指数
版本由Index(0)所隐含.
参数
element在数组中定位的值arr初始阵列
回返情况: 匹配元素索引或 - 1
插入
创建新数组,并在提供的索引中添加值. 将旧值移到右边. 如果索引超出数组的约束范围 - 作为最后一个元素添加一个值 .
参数
value额外价值index具体指数arr初始阵列
回返情况: 新建阵列
加入时
Array.prototype.join 的功能包装器
添加由指定的分隔符字符串分隔的数组的所有元素.
参数
separator分隔符arr初始阵列
回返情况: 组合数组元素的字符串 .
密钥
Array.prototype.keys 的功能包装器
返回数组中的可移动密钥
参数
arr初始阵列
回返情况: 显示器
最后一个( l)
获取数组的最后一个元素.
参数
arr初始阵列
回返情况: 最后一个元素( 未定义为空数组)
最后一个 索引
Array.prototype.last 的功能包装器 索引
检索数组中指定值最后出现的索引. 从Index开始向后搜索数组.
参数
element在数组中定位的值fromIndex开始搜索的数组索引arr初始阵列
回返情况: 匹配元素索引或 - 1
上个 IndexOf. all (简体中文)
版本由Index所隐含(ar.長 - 1).
参数
element在数组中定位的值arr初始阵列
回返情况: 匹配元素索引或 - 1
地图
Array.prototype.map 的功能包装器
调用一个阵列中每个元素上定义的映射函数, 并返回包含结果的数组.
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
预设( p)
在数组开头添加一个值. 类似于Array.prototype.unshit,但不可改变.
参数
value额外价值arr初始阵列
回返情况: 新建阵列
范围
在指定范围内创建数组 - 上升或下降.
参数
from起始数(包括)to期末数(不包括)step步( 必须大于零) (可选, 默认)1(中文(简体) )
回返情况: 范围数组
减少
Array.prototype. 减少功能包装器
为数组中的所有元素调用指定的还原函数. 减少函数的返回值是累积结果, ,并在下次调用还原函数时作为参数提供.
参数
reducingFn减少功能initialValue累积器的初始值arr初始阵列
回返情况: 最后累积值
减. 第一个
减少不初始化. 阵列的第一个元素将作为初始积分.
参数
reducingFn减少功能arr初始阵列
回返情况: 最后累积值
减少右边
用于 Array.prototype. reduction Right 的功能包装器
调用一个阵列中所有元素的指定回调函数, 以降为序. 减少函数的返回值是累积结果, ,并在下次调用还原函数时作为参数提供.
参数
reducingFn减少功能initialValue累积器的初始值arr初始阵列
回返情况: 最后累积值
减少权利。 第一个
减少不初始化. 数组的最后一个元素将用作初始积分.
参数
reducingFn减少功能arr初始阵列
回返情况: 最后累积值
删除
在提供的索引中创建一个没有项目的新数组.
参数
index具体指数arr初始阵列
回返情况: 新建阵列
暂停
创建没有第一个元素的新数组.
参数
arr初始阵列
回返情况: 新建阵列
倒转
创建带有倒转元素的新数组.
参数
arr初始阵列
回返情况: 新建阵列
设定
在提供的索引上创建一个新值的新数组.
如果索引脱离了数组的束缚,则丢出一个错误.
参数
value新价值index具体指数arr初始阵列
回返情况: 新建阵列
设置
创建一个被调整/扩展到所提供大小的新阵列. 如果新数组长于初始数组, 其他索引将设置为未定义.
参数
size所需规模arr初始阵列
回返情况: 新建阵列
大小
获取数组的大小( 长度) .
参数
arr初始阵列
回返情况: 阵列大小( 长)
切开
Array.prototype.slice 的功能包装器
创建一个新的数组,作为初始数组的一个部分.
参数
from数组指定部分的起始 .to数组指定部分的结束 .arr初始阵列
回返情况: 新建阵列
切片 从
版本带有隐性末端索引(ar. long).
参数
from数组指定部分的起始 .arr初始阵列
回返情况: 新建阵列
切开. to
版本带有隐含的起始索引 (0).
参数
to数组指定部分的结束 .arr初始阵列
回返情况: 新建阵列
有点
Array.prototype 的功能包装
确定指定的测试功能 返回数组中任何元素的正数.
参数
testFn测试函数arr初始阵列
回返情况: 如果任何元素满足测试功能, 则为真, 否则为假
排序
创建新排序的数组. 有内置的数值和字符串数组排序方法 .
参数
compareFn比较函数arr初始阵列
回返情况: 新建阵列
排序.num
按上升顺序排序数字数组.
参数
arr初始阵列
回返情况: 新建阵列
类型.numDesc
按下行顺序排序数字数组.
参数
arr初始阵列
回返情况: 新建阵列
排序.str
使用比较运算符将字符串数组按升序排序.
参数
arr初始阵列
回返情况: 新建阵列
类型.strDesc
使用比较运算符按下行顺序排序字符串数组.
参数
arr初始阵列
回返情况: 新建阵列
类型
使用升序排序字符串数组 String.prototype.localeCompare。 。 。 .
参数
arr初始阵列
回返情况: 新建阵列
类型
使用降序排序字符串数组 String.prototype.localeCompare。 。 。 .
参数
arr初始阵列
回返情况: 新建阵列
排序为
创建新排序的数组. 接受映射函数,在比较前先映射值 (映射不影响阵列的实际值). 拥有内置的数值和字母排序方法.
参数
compareFn比较函数mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
排序为 .num
按上升顺序排序数字数组.
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
排序为 .numDesc
按下行顺序排序数字数组.
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
排序为 .str
使用比较运算符将字符串数组按升序排序.
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
排序为 .strDesc
使用比较运算符按下行顺序排序字符串数组.
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
排序为 . locale
使用升序排序字符串数组 String.prototype.localeCompare。 。 。 .
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
排序为 . localeDesc
使用降序排序字符串数组 String.prototype.localeCompare。 。 。 .
参数
mappingFn绘图函数arr初始阵列
回返情况: 新建阵列
转到本地结构
用于 Array.prototype.to LocaleString 的功能包装器
创建数组的字符串表达式. 元素被转换成字符串,使用其到LocalString的方法.
参数
arr初始阵列
回返情况: 字符串代表制
倒数
Array.prototype.toString 的功能包装器
创建数组的字符串表达式.
参数
arr初始阵列
回返情况: 字符串代表制
更新
创建新数组,并在提供的索引中设定新值, 通过将旧值映射到新值的更新器函数来计算.
如果索引脱离了数组的束缚,则丢出一个错误.
参数
value新价值index具体指数arr初始阵列
回返情况: 新建阵列
数值
Array.prototype.值的功能包装
创建数组中的可移动值.
参数
arr初始阵列
回返情况: 显示器
拉链
将两个阵列组合成一对阵列 包含相应的索引上的值. Zips直到达到更短阵列的长度.
参数
otherArr要用初始数组拉链的矩阵arr初始阵列
回返情况: 新建已拉链的阵列
全部拉链
Zips直到更长数组的长度被达到.
参数
otherArr要用初始数组拉链的矩阵arr初始阵列
回返情况: 新建已拉链的阵列
zipWith (帮助)
将两个数组带拉链功能生成新值, 使用相同索引的元素. Zips直到达到更短阵列的长度.
参数
zippingFn跳动函数otherArr要用初始数组拉链的矩阵arr初始阵列
回返情况: 新建已拉链的阵列
zipWith .all (全称)
Zips直到更长数组的长度被达到.
参数
zippingFn跳动函数otherArr要用初始数组拉链的矩阵arr初始阵列
回返情况: 新建已拉链的阵列
许可证
项目处于开放式、非限制性 ISC 许可证。 。 。 .