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