Instalación

Instala listingsapi-js desde npm, elige ESM o CJS y verifica tu configuración.

Requisitos

• Node.js 18 o posterior
• npm, pnpm o yarn

El SDK usa fetch nativo (incluido en Node 18+) y no tiene dependencias en tiempo de ejecución.

• Código fuente: github.com/listings-api/listingsapi-nodejs-sdk
• Versiones: npmjs.com/package/listingsapi-js

Instalación

npm install listingsapi-js

# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-js

ESM y CJS

listingsapi-js incluye una compilación ESM y otra CommonJS. El punto de entrada correcto se selecciona automáticamente según la configuración de type de tu proyecto.

ESM ("type": "module" en package.json o extensión .mts/.mjs):

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

CJS (resolución de módulos predeterminada de Node o extensión .cts/.cjs):

const { ListingsAPI, APIError } = require('listingsapi-js');

TypeScript

Las definiciones de tipos se incluyen en el paquete, por lo que no necesitas instalar @types/listingsapi-js por separado. El SDK está escrito en TypeScript y la carpeta dist/ incluye archivos .d.ts (y .d.cts para la compilación CommonJS) para todas las exportaciones.

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

Fijar la versión

Esta documentación se ha probado con listingsapi-js 0.3.2.

npm install listingsapi-js@0.3.2

O en package.json:

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

Verificación

import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'your-api-key' });console.log('listingsapi-js ready', typeof client.fetchAllLocations);

npx tsx verify.ts

Siguientes pasos

• Inicio rápido: conéctate y realiza tu primera llamada a la API
• Configuración: sustitución de la URL base y configuración del proyecto TypeScript