@arcjet/redact
弧喷 帮助开发人员在几行中保护自己的应用 代码。 执行费率限制、机器人保护、电子邮件核查和防御 打击普通攻击.
这是 弧喷 类型脚本和 JavaScript 敏感信息 编辑库.
见 docs.arcjet.com 更多关于API.
这是什么?
此软件包为编辑敏感信息提供了功能. 工作是在WebAssembly完成的,但从JavaScript这里调用.
Web Assembly 文件在 @arcjet/redact-wasm。 。 。 .
更多关于我们为什么维护 WebAssembly 和 JavaScript 项目的信息
这个,
见 “这是什么?”
@arcjet/analyze-wasm。 。 。 .
我什么时候用这个?
您可以使用此软件包来编辑本地的敏感信息 . 您可以编辑电子邮件地址、信用卡号码等. 也可以扭转这个过程:不编辑所发现的东西.
安装
这套方案只是无害环境管理. 在 Node.js 用 npm 安装 :
npm install @arcjet/redact
使用
import { redact } from "@arcjet/redact";
const value = "Hi, my name is John and my email adress is [email protected]";
const [redacted, unredact] = await redact(value, {
entities: ["email", "phone-number"],
});
console.log(redacted);
// => "Hi, my name is John and my email adress is <Redacted email #0>"
const unredacted = unredact("Your email address is <Redacted email #0>");
console.log(unredacted); // "Your email address is [email protected]"
API 密码
此软件包导出标识符
redact。 。 。 .
没有默认导出 .
此套件导出 类型脚本 类型
ArcjetSensitiveInfoType 财务报告和审定财务报表
RedactOptions。 。 。 .
ArcjetSensitiveInfoType
此类型代表了可以检测的敏感信息类型 从盒子里出来.
类型
type ArcjetSensitiveInfoType =
| "credit-card-number"
| "email"
| "ip-address"
| "phone-number";
RedactOptions
您可以通过这些选项来配置 redact 工作时.
字段
contextWindowSize(单位:千美元)number,默认值 :1(中文(简体) ) 需要考虑上下文的符号数量detect(单位:千美元)(tokens: string[]) => ReadonlyArray<string | undefined>,可选) - 识别敏感信息的自定义检测功能entities(单位:千美元)Array<string>,默认:所有内建和检测实体) ——哪些实体要修改;这包括内置ArcjetSensitiveInfoTypes 和 您返回的自定义类型detect函数replace(单位:千美元)(entity: string, plaintext: string) => string | undefined,可选) ——自定义替换功能来控制敏感信息是如何存在的 已编辑
redact(candidate[, options])
编辑字符串中的敏感信息。 您可以使用返回的密码
unredact 函数以在稍后恢复原始值.
参数
candidate(单位:千美元)string(中文(简体) ) ——要编辑的字符串options(单位:千美元)RedactOptions,可选) - 编辑内容和方式的配置
回返
此函数返回 a Promise {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}这决定了与修饰者纠缠在一起
字符串和可以卸取的函数( y)Promise<[string, Unredact]>) (中文(简体) ).