Installazione
Installa listingsapi-js da npm, scegli ESM o CJS e verifica la configurazione.
Requisiti
- Node.js 18 o versioni successive
- npm, pnpm o yarn
L'SDK usa fetch nativo (integrato in Node 18+) e non ha dipendenze di runtime.
- Codice sorgente: github.com/listings-api/listingsapi-nodejs-sdk
- Versioni: npmjs.com/package/listingsapi-js
Installazione
npm install listingsapi-js# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-jsESM e CJS
listingsapi-js include sia una build ESM sia una build CommonJS. Il punto di ingresso corretto viene scelto automaticamente in base all'impostazione type del tuo progetto.
ESM ("type": "module" in package.json o estensione .mts/.mjs):
import { ListingsAPI, APIError } from 'listingsapi-js';CJS (risoluzione predefinita dei moduli di Node o estensione .cts/.cjs):
const { ListingsAPI, APIError } = require('listingsapi-js');TypeScript
Le definizioni dei tipi sono incluse nel pacchetto, quindi non serve un @types/listingsapi-js separato. L'SDK è scritto in TypeScript e la cartella dist/ include file .d.ts (e .d.cts per la build CommonJS) per tutti gli elementi esportati.
# No extra step needed: types come with the packagenpm install listingsapi-jsFissa la versione
Questa documentazione è stata verificata con listingsapi-js 0.3.2.
npm install listingsapi-js@0.3.2Oppure in package.json:
{"dependencies": { "listingsapi-js": "^0.3.2"}}Verifica
import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'your-api-key' });console.log('listingsapi-js ready', typeof client.fetchAllLocations);npx tsx verify.tsPassaggi successivi
- Guida rapida: connettiti ed effettua la tua prima chiamata API
- Configurazione: personalizzazione dell'URL di base e configurazione del progetto TypeScript