快速开始

本页将帮助你快速上手 relationship-ts。

安装

npm

npm install relationship-ts

pnpm

pnpm add relationship-ts

yarn

yarn add relationship-ts

bun

bun add relationship-ts

基本使用

导入模块

// 主库（简体中文）
import relationship from 'relationship-ts';

// 繁体中文版本
import relationship from 'relationship-ts/zh-HK';

查询称谓

import relationship from 'relationship-ts';

// 简单关系
relationship({ text: '爸爸的妈妈' });
// => ['奶奶', '祖母']

// 复杂关系
relationship({ text: '妈妈的哥哥的老婆' });
// => ['舅妈', '舅母']

指定性别

// 我是男性，称呼哥哥的老婆
relationship({ text: '哥哥的老婆', sex: 1 });
// => ['嫂子', '嫂嫂', '阿嫂']

// 我是女性，称呼哥哥的老婆
relationship({ text: '哥哥的老婆', sex: 0 });
// => ['嫂子', '嫂嫂', '阿嫂']

反向查询

查询对方应该如何称呼我：

// 我是男性，外婆应该叫我什么？
relationship({ text: '外婆', reverse: true, sex: 1 });
// => ['外孙']

// 我是女性，外婆应该叫我什么？
relationship({ text: '外婆', reverse: true, sex: 0 });
// => ['外孙女']

浏览器直接引入

通过 CDN 或本地文件引入：

<!-- 主库（简体中文） -->
<script src="https://cdn.jsdelivr.net/npm/relationship-ts/dist/relationship.min.js"></script>

<!-- 繁体中文版本 -->
<script src="https://cdn.jsdelivr.net/npm/relationship-ts/dist/lang/relationship.zh-HK.min.js"></script>

<!-- 使用 -->
<script>
  const result = relationship({ text: '爸爸的妈妈' });
  console.log(result); // ['奶奶', '祖母']
</script>

下一步

• 查看 基础用法 了解更多使用方式
• 查看 API 文档 了解完整 API
• 查看 方言支持 了解如何使用不同方言