@goldenhippo/gh-surveys

中文文档
0.0.46发布于 2024/02/06UNLICENSEDTypeScriptESM + CJS近 30 天下载 3815

Golden Hippo 初步调查包

中文使用文档
文档目录5 节
  1. 目录
  2. 安装
  3. 使用量
  4. 调查API
  5. 调查答复

金色希波调查

目录

安装

npm i @goldenhippo/gh-surveys

此软件包需要您使用一个可公开访问的 URL 配置 GH 调查 API 实例 .

使用量

调查API

从软件包中导入 SurveyAPI 类,并用连接字符串将其即时化为已部署的API. 连接字符串的格式应该是: https://surveyapi.herokuapp.com (或无论部署的API URL是什么).

注:URL末尾不应有斜线.

import { SurveyAPI } from "@goldenhippo/gh-surveys";

const surveyAPI = new SurveyAPI(
  "https://surveyapi.herokuapp.com"
);

A. 调查方法

调查API类别有以下方法:

  • retrieve(sessionId: string) - 获取特定会话ID的所有回复。 返回解析到一系列测量检索回复对象的保证 .
  • ensureTableExists(create: boolean = false) - 确认数据库中存在调查-答复表。 如果它不存在,则 create 参数可以被传递来创建表格。 返回一个解析为布尔表示表格是否存在的保证。 这个过程只应在应用程序启动时运行,因为它是一个昂贵的操作.
  • submitToDB(surveyResponse: SurveyResponse) - 向数据库提交调查答复对象。 返回解决 SurveySubmitResponse 对象的保证.

调查API 使用情况

import { SurveyAPI } from "@goldenhippo/gh-surveys";

const surveyAPI = new SurveyConnection(
  "https://surveyapi.herokuapp.com"
);

const responses = surveyAPI.retrieve("1234")
  .then((sessionResponses) => {
      console.log(sessionResponses);
      //Find the age response
      const ageResponse = sessionResponses.find(response => response instanceof SurveyResponse.Age)
      if(ageResponse) {
      const ageSelection = ageResponse.answer
      //Do something based on the answer which will be one of the enum options
    }
  })

const tableExists = await surveyAPI.ensureTableExists(); // Validate that table exists, but do not create it if it does not.
console.log(tableExists);

const tableExistsWithCreate = await surveyAPI.ensureTableExists(true); // Validate that table exists, and create it if it does not.
console.log(tableExistsWithCreate);

调查答复

调查响应类是一个抽象的类,应当被扩展,为特定的调查问题类型创建一个响应. 创建对象然后可以使用 SurveyAPI.submitToDB 方法并返回解析到 SurveySubmitResponse 对象.

反应对象的结构如下:

{
  success: boolean,
  response: {
    answer: string,
    sessionId: string,
    questionType: string
  } | null
}
import { SurveyAPI, SurveyResponse } from "@goldenhippo/gh-surveys";

const surveyAPI = new SurveyAPI(
  "https://surveyapi.herokuapp.com"
);

const ageResponse = new SurveyResponse.Age({
  question: "How old are you?",
  rawAnswer: "21",
  answer: "AGE_18_24",
  sessionId: "1234",
});
const ageSubmission = apiConnection.submitToDB(ageResponse)
.then((response) => {
  console.log(response);
  /*
   {
      success: true,
      response: {
        answer: "AGE_18_24",
        sessionId: "1234",
        questionType: "AGE"
      }
   }
   */
}

问题类型

调查响应类允许您为下列问题类型创建响应:

  • 年龄
  • 性别
  • 消化问题
  • 问题时代
  • 周而复始
  • 解决方案

注意: 要查看可用的问答, 您可以从您的 API URL 访问配置文件 /config。例如, https://yourapi.herokuapp.com/config。 。 。 .

答复

每个问题类型都有一套可能的答案. 答案被定义为类上的静态属性. 例如 SurveyResponse.Gender 类有以下可能的答案:

  • 马里
  • 妇女
  • 非两年期
  • 解禁线 TO ANSWER

注意: 要查看可用的问答, 您可以从您的 API URL 访问配置文件 /config。例如, https://yourapi.herokuapp.com/config。 。 。 .

版本与发布记录

@goldenhippo/gh-surveys 共发布 48 个版本,首次发布于 2023/04/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.46latest2024/02/062 年前
0.0.452024/02/012 年前
0.0.442023/12/212 年前
0.0.432023/07/043 年前
0.0.422023/06/273 年前
0.0.412023/06/273 年前

其他发布通道:stable → 0.0.22,beta → 0.0.38-beta.0。

关于 @goldenhippo/gh-surveys 的常见问题

@goldenhippo/gh-surveys 是什么?

Golden Hippo 初步调查包

如何安装 @goldenhippo/gh-surveys?

在项目目录运行 npm install @goldenhippo/gh-surveys,或使用 pnpm add / yarn add / bun add。

@goldenhippo/gh-surveys 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@goldenhippo/gh-surveys 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@goldenhippo/gh-surveys 可以商用吗?

@goldenhippo/gh-surveys 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@goldenhippo/gh-surveys 的下载量有多少?

根据 npm 官方下载统计,@goldenhippo/gh-surveys 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,815 次,日均约 127 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@goldenhippo/gh-surveys 还在维护吗?

最新版本 0.0.46 发布于 2024/02/06(2 年前);至今共发布 48 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/04/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。