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
npm install listingsapi-js# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-jsESM 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ı):
import { ListingsAPI, APIError } from 'listingsapi-js';CJS (varsayılan Node modül çözümlemesi veya .cts/.cjs uzantısı):
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.
# No extra step needed: types come with the packagenpm install listingsapi-jsSürümü sabitleyin
Bu dokümantasyon listingsapi-js 0.3.2 ile test edilmiştir.
npm install listingsapi-js@0.3.2Veya package.json içinde:
{"dependencies": { "listingsapi-js": "^0.3.2"}}Doğrulama
import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'your-api-key' });console.log('listingsapi-js ready', typeof client.fetchAllLocations);npx tsx verify.tsSonraki adımlar
- Hızlı başlangıç: bağlanın ve ilk API çağrınızı yapın
- Yapılandırma: temel URL'yi geçersiz kılma ve TypeScript projesi kurulumu