Listings APIListings API
登录

安装

从 npm 安装 listingsapi-js，选择 ESM 或 CJS，并验证您的配置。

环境要求

  • Node.js 18 或更高版本
  • npm、pnpm 或 yarn

SDK 使用原生 fetch（Node 18+ 内置），没有任何运行时依赖。

安装

bash
npm install listingsapi-js
bash
# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-js

ESM 和 CJS

listingsapi-js 同时包含 ESM 和 CommonJS 构建版本。系统会根据您项目的 type 设置自动选择正确的入口。

ESM（在 package.json 中设置 "type": "module"，或使用 .mts/.mjs 扩展名）：

TypeScript
import { ListingsAPI, APIError } from 'listingsapi-js';

CJS（使用默认的 Node 模块解析方式，或使用 .cts/.cjs 扩展名）：

JavaScript
const { ListingsAPI, APIError } = require('listingsapi-js');

TypeScript

包中已包含类型定义，因此无需单独安装 @types/listingsapi-js。SDK 使用 TypeScript 编写，dist/ 文件夹包含所有导出项的 .d.ts 文件（以及 CommonJS 构建版本的 .d.cts 文件）。

bash
# No extra step needed: types come with the packagenpm install listingsapi-js

固定版本

本文档已使用 listingsapi-js 0.3.2 进行测试。

bash
npm install listingsapi-js@0.3.2

或者在 package.json 中配置：

json
{"dependencies": {  "listingsapi-js": "^0.3.2"}}

验证

verify.ts
import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'your-api-key' });console.log('listingsapi-js ready', typeof client.fetchAllLocations);
bash
npx tsx verify.ts

后续步骤

  • 快速入门：连接并进行您的首次 API 调用
  • 配置：覆盖基础 URL 和设置 TypeScript 项目