Kurulum

listingsapi-js paketini npm üzerinden yükleyin, ESM veya CJS seçin ve kurulumunuzu doğrulayın.

Gereksinimler

  • Node.js 18 veya üzeri
  • npm, pnpm veya yarn

SDK, yerleşik fetch kullanır (Node 18 ve üzeri sürümlere dahildir) ve hiçbir çalışma zamanı bağımlılığı yoktur.

Kurulum

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

ESM ve CJS

listingsapi-js, hem ESM hem de CommonJS derlemesini içerir. Doğru giriş noktası, projenizin type ayarına göre otomatik olarak seçilir.

ESM (package.json içinde "type": "module" veya .mts/.mjs uzantısı):

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

CJS (varsayılan Node modül çözümlemesi veya .cts/.cjs uzantısı):

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

TypeScript

Tür tanımları pakete dahildir, bu nedenle ayrı bir @types/listingsapi-js gerekmez. SDK, TypeScript ile yazılmıştır ve dist/ klasörü, dışa aktarılan tüm öğeler için .d.ts dosyalarını (ve CommonJS derlemesi için .d.cts dosyalarını) içerir.

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

Sürümü sabitleyin

Bu dokümantasyon listingsapi-js 0.3.2 ile test edilmiştir.

bash
npm install listingsapi-js@0.3.2

Veya package.json içinde:

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

Doğrulama

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

Sonraki adımlar