# nw-app-snail

> 蜗牛wap页打开app功能支持模块

Latest version **2.9.24** (published 2026-06-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install nw-app-snail
pnpm add nw-app-snail
yarn add nw-app-snail
bun add nw-app-snail
```

## Health

**Score 50/100 (C)** — status: active.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.9.24 |
| Published | 2026-06-08 |
| First published | 2017-11-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 55.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hzliushichuan@corp.netease.com |
| Maintainers | guoyeeg, azgaga, liushichuan, yaochen, shenyuan, aflyermin, ignous, jeekdong, yousy, luofeiyue, whiskeyi, fechen |
| Keywords | snailReader, 网易蜗牛读书 |

## Links

- npm: https://www.npmjs.com/package/nw-app-snail
- npm.io page: https://npm.io/package/nw-app-snail

## Dependencies (3)

- [qs](https://npm.io/package/qs.md) ^6.5.2
- [nw-detect](https://npm.io/package/nw-detect.md) ^2.31.1
- [nejsbridge](https://npm.io/package/nejsbridge.md) latest

## Recent versions

- 2.9.24 (latest) — 2026-06-08
- 2.9.23 — 2025-06-23
- 2.9.22 — 2025-06-22
- 2.9.21 — 2025-06-22
- 2.9.20 — 2025-04-17
- 2.9.19 — 2025-04-17
- 2.9.18 — 2025-04-10
- 2.9.17 — 2025-04-09
- 2.9.16 — 2025-04-08
- 2.9.15 — 2024-12-11
- 2.9.14 — 2024-12-11
- 2.9.13 — 2024-11-12
- 2.9.12 — 2024-11-11
- 2.9.11 — 2024-04-02
- 2.9.10 — 2024-01-29
- … 58 more at https://npm.io/package/nw-app-snail/versions

## README

# nw-app-snail

## 功能

在H5中尝试打开网易蜗牛读书App的特定页面，如果没有安装或者没有成功打开，则跳转App下载页

## 使用

npm: 通过npm安装`nw-app-snail`，再通过模块引用方式引入即可调用`openAppSnail()`完成跳转

```javascript 
import openAppSnail from 'nw-app-snail'
//import * as open from 'nw-app-snail'
openAppSnail({
    path: 'bookreview',
    query: {
        bookReviewId: 286436
    }
})
```

直接引用：下载/dist/bundle.js到工程中即可调用NWAppSnail.openAppSnail()方法完成跳转

```html
<script src="bundle.js"></script>
<script>
    NWAppSnail.openAppSnail({
        path: 'bookreview',
        query: {
            bookReviewId: 286436
        }
    })
</script>
```

## 开发
### es module 打包
根目录下执行`npm run build`即可
### umd module 打包
本目录下执行`npm run build`即可

## 参数

参数为Object类型，参数各字段定义如下：

| 参数属性 | 类型 | 描述 |
| --- | --- | --- |
| path | String | h5跳转应用内页面类型 |
| query | Object | h5跳转应用内页面参数 |
| replace | boolean | 是否使用location.replace代理location.href进行跳转,默认为false |

参数示例：
```javascript
{
    path: 'bookreview',
    query: {
        bookReviewId: 286436
    }
}
```


具体可用path和query参数如下：

**此列表不定时更新，完整列表可查看（蜗牛读书客户端SchemeUrl wiki），此文档展示了所有可供调用的scheme，第一列即为`path`，第二列即为`query`所需参数**

| path | query | 描述 |
| --- | --- | --- |
| bookdetail | bookId：书籍id | 书籍详情 |
| bookcontent | bookId：书籍id articleId：章节id 非必传| 书籍正文页 |
| booklist | bookListId：书单id | 书单页（书单功能已弃用） |
| webview | url：打开的连接地址 inside：boolean变量，是否用内嵌浏览器打开，默认为false（即外部浏览器打开） | 通过浏览器或者webview打开url |
| userinfo | uuid：用户uuid | 用户个人主页 |
| privatemsg | useruuid：用户uuid | 用户私信对话界面 |
| bookrank | moduleId：模块id entryId：排行榜id title：榜单名称 type：榜单类型（read：在读榜，new：新书榜）| 书籍排行榜 |
| bookreview | bookReviewId：书评id | 书评详情页 |
| newbookreview | 无 | 写书评 |
| question | questionId: 问题id | 问题回答页 |
| questionlist | bookId: 书籍id | 书籍的问题列表 |
| bookstore | 无 | 书城（目前的分类页） |
| messagenotify | 无 | 消息列表通知选项卡 |
| messagecomment | 无 | 消息列表评论选项卡 |
| messageanswer | 无 | 消息列表回答选项卡 |
| messagelist | 无 | 我的消息列表 |
| feedback | 无 | 用户反馈 |
| followlist | type：follow表示关注列表，fans表示粉丝列表  uuid：用户uuid，如果不传表示当前登录用户| 用户反馈 |
| setting | 无 | 设置 |
| subject | moduleId：模块id entryId：专题id（如果不传表示获取专题列表）| 专题页 |
| bookexchange | type：exchanged表示已兑换页面，book表示兑换页面 | 书籍兑换页面 |
| ... | 更多可控调用的scheme请查看（蜗牛读书客户端SchemeUrl) | 如无权限可联系hzliushichuan |

---
_Source: https://npm.io/package/nw-app-snail · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._