@awo00/smb2
A SMB2 implementation in TypeScript.
Forked from https://github.com/ardean/smb2 using code from https://github.com/SamDecrock/node-http-ntlm to fix Node 17+ OpenSSL error to prevent having to use legacy support.
Installation
$ npm i @awo00/smb2
Usage
import smb2 from "@awo00/smb2";
const client = new smb2.Client(host);
const session = await client.authenticate({
domain,
username,
password
});
const tree = await session.connectTree(share);
const entries = await tree.readDirectory("/");
console.log(entries);
Features
Client
- watch shares for file and directory changes
- create, read & remove & rename files
- create, list & remove & rename directories
- check directory/file exists
WIP
License
MIT
关于 @awo00/smb2 的常见问题
@awo00/smb2 是什么？
A SMB2 implementation in TypeScript
如何安装 @awo00/smb2？
在项目目录运行 npm install @awo00/smb2，或使用 pnpm add / yarn add / bun add。
@awo00/smb2 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@awo00/smb2 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@awo00/smb2 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@awo00/smb2 可以商用吗？
@awo00/smb2 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@awo00/smb2 的下载量有多少？
根据 npm 官方下载统计，@awo00/smb2 在 2026/10/07 – 2026/11/05 这 30 天内被下载 13,591 次，日均约 453 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@awo00/smb2 还在维护吗？
最新版本 1.1.1 发布于 2025/05/21（1.5 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/12/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。