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.

Installazione

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

ESM 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):

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

CJS (risoluzione predefinita dei moduli di Node o estensione .cts/.cjs):

JavaScript
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.

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

Fissa la versione

Questa documentazione è stata verificata con listingsapi-js 0.3.2.

bash
npm install listingsapi-js@0.3.2

Oppure in package.json:

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

Verifica

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

Passaggi successivi

  • Guida rapida: connettiti ed effettua la tua prima chiamata API
  • Configurazione: personalizzazione dell'URL di base e configurazione del progetto TypeScript