API Reference > @easyops-cn/brick-next-pipes
brick-next-pipes package
用于 Brick Next 的 Pipes 管道列表。源代码托管在 GitHub easyops-cn/brick-next-pipes。
Remarks
使用 TypeScript：
import { pipes } from "@easyops-cn/brick-next-pipes";
const stringified = pipes.yamlStringify(yourObject);
在编排中使用求值占位符：
prop: "<% yourObject |> PIPES.yamlStringify %>"
# or
prop: "<% PIPES.yamlStringify(yourObject) %>"
在编排中使用注入占位符或 Transform：
prop: "${ yourObject | yamlStringify }"
# or
prop: "@{ yourObject | yamlStringify }"
Functions
| Function | Description |
|---|---|
| add | 数学加法或字符串拼接。 Mathematics |
| boolean | 将一个值转换为布尔值（也可使用别名 bool）。 Type conversion |
| cmdbInstanceShowName | 获得一个 CMDB 实例的展示名。 Others |
| countBy | 统计一个集合中每个元素的指定属性（或迭代器执行结果）的值出现的次数。 Collection |
| datetime | 日期时间格式化（使用当地时区）。 Datetime |
| deltaTime | 将一个时间段转换为人类可读的文本。 Datetime |
| divide | 数学除法。 Mathematics |
| equal | 比较两个值是否相同（深度比较）。 Logic |
| find | 从一个数据集合中找到第一个匹配的元素。 Collection |
| findIndex | 从一个数组中找到第一个匹配的元素的位置。 Array |
| findLast | 从一个数据集合中从后向前找到第一个匹配的元素。 Collection |
| findLastIndex | 从一个数组中从后向前找到第一个匹配的元素的位置。 Array |
| get | 获取一个对象指定属性（路径）的值。 |
| graphTree | 将图遍历查询接口返回的图数据转换为树结构数据。 Others |
| groupBy | 把一个集合按指定属性（或迭代器执行结果）的值进行分组。 Collection |
| groupByToIndex | 返回一个数组的拷贝，并为每个元素新增一个分组索引字段。 Others |
| includes | 判断一个数组是否包含指定元素，或一个字符串是否包含指定子串。 Array |
| join | 将一个数组的所有元素拼接成字符串。 Array |
| json | 解析一个 JSON 格式的字符串（反序列化）。 Serialization |
| jsonStringify | 将一个值转换为 JSON 格式的字符串（序列化）。 Serialization |
| keyBy | 将指定属性（或迭代器执行结果）作为键名收集一个集合中的元素。 Collection |
| map | 通过填充调用数组中各项的指定属性来创建一个新数组。 Array |
| mapToArray | 将一个对象根据键值对映射转换为数组。 Others |
| mergeArrayByKey | 将多个对象数组根据键合并为一个数组, 对于数组类型的属性不会 deep merge, 只会 concat。 Array |
| multiply | 数学乘法。 Mathematics |
| not | 布尔取反。 Logic |
| nullish | 空值合并（??）。 Logic |
| number | 将输入值转换为数字。 Type conversion |
| parseTimeRange | 解析一个时间字符串。 Datetime |
| randomString | 获得一个随机字符串 Others |
| reverse | 返回一个数组倒转之后的新数组。 Array |
| round | 获取一个数值的近似值。 Mathematics |
| slice | 根据起始位置和结束位置（不包含）返回一个数组的一部分。 Array |
| sort | 返回一个数组按指定属性排序后的新数组。 Array |
| split | 将一个字符串分割为字符串列表。 String |
| string | 将输入值转换为字符串。 Type conversion |
| substr | 根据指定起始位置和长度返回一个字符串的子串。 String |
| substring | 根据指定起始位置和结束位置（不包含）返回一个字符串的子串。 String |
| subtract | 数学减法。 Mathematics |
| ternary | 三元运算，根据条件返回两个值中的一个。 Logic |
| uniq | 获取一个数组去重后的新数组。 Array |
| unitFormat | 将一个数值转换为带单位的数据。 Others |
| yaml | 解析一个 YAML 格式的字符串（反序列化）。 Serialization |
| yamlStringify | 将一个值转换为 YAML 格式的字符串（序列化）。 Serialization |
Interfaces
| Interface | Description |
|---|---|
| GraphData | A graph data. |
| GraphEdge | A graph edge. |
| GraphQuery | A graph query. |
| GraphVertex | A graph vertex. |
| Period | 一个时间段。 |