Instalasi
Instal listingsapi-js dari npm, pilih ESM atau CJS, lalu verifikasi konfigurasi Anda.
Persyaratan
- Node.js 18 atau yang lebih baru
- npm, pnpm, atau yarn
SDK ini menggunakan fetch bawaan (tersedia di Node 18+) dan tidak memiliki dependensi runtime.
- Kode sumber: github.com/listings-api/listingsapi-nodejs-sdk
- Rilis: npmjs.com/package/listingsapi-js
Instalasi
npm install listingsapi-js# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-jsESM dan CJS
listingsapi-js menyertakan build ESM dan build CommonJS. Titik masuk yang sesuai dipilih secara otomatis berdasarkan pengaturan type proyek Anda.
ESM ("type": "module" di package.json atau ekstensi .mts/.mjs):
import { ListingsAPI, APIError } from 'listingsapi-js';CJS (resolusi modul default Node atau ekstensi .cts/.cjs):
const { ListingsAPI, APIError } = require('listingsapi-js');TypeScript
Definisi tipe disertakan dalam paket, sehingga @types/listingsapi-js terpisah tidak diperlukan. SDK ini ditulis dalam TypeScript, dan folder dist/ menyertakan file .d.ts (serta .d.cts untuk build CommonJS) untuk semua ekspor.
# No extra step needed: types come with the packagenpm install listingsapi-jsKunci versi
Dokumentasi ini diuji dengan listingsapi-js 0.3.2.
npm install listingsapi-js@0.3.2Atau di package.json:
{"dependencies": { "listingsapi-js": "^0.3.2"}}Verifikasi
import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'your-api-key' });console.log('listingsapi-js ready', typeof client.fetchAllLocations);npx tsx verify.tsLangkah selanjutnya
- Panduan mulai cepat: hubungkan dan lakukan panggilan API pertama Anda
- Konfigurasi: penggantian URL dasar dan penyiapan proyek TypeScript