Listings APIListings API
تسجيل الدخول

التثبيت

ثبّت listingsapi-js من npm، واختر 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 ("type": "module" في package.json أو الامتداد .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 (وملفات .d.cts للنسخة المبنية بصيغة CommonJS) لجميع العناصر المُصدَّرة.

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

الخطوات التالية