Instalação

Instale listingsapi-js pelo npm, escolha ESM ou CJS e verifique sua configuração.

Requisitos

Node.js 18 ou posterior
npm, pnpm ou yarn

O SDK usa fetch nativo (integrado ao Node 18+) e não tem dependências em tempo de execução.

Código-fonte: github.com/listings-api/listingsapi-nodejs-sdk
Versões: npmjs.com/package/listingsapi-js

Instalação

bash

npm install listingsapi-js

bash

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

ESM e CJS

listingsapi-js inclui uma compilação ESM e uma compilação CommonJS. O ponto de entrada correto é escolhido automaticamente com base na configuração type do seu projeto.

ESM ("type": "module" em package.json ou extensão .mts/.mjs):

TypeScript

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

CJS (resolução de módulos padrão do Node ou extensão .cts/.cjs):

JavaScript

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

As definições de tipos estão incluídas no pacote, portanto não é necessário instalar @types/listingsapi-js separadamente. O SDK é escrito em TypeScript, e a pasta dist/ inclui arquivos .d.ts (e .d.cts para a compilação CommonJS) para todas as exportações.

bash

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

Fixar a versão

Esta documentação foi testada com listingsapi-js 0.3.2.

bash

npm install listingsapi-js@0.3.2

Ou em package.json:

json

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

Verificação

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

Próximos passos

Início rápido: conecte-se e faça sua primeira chamada à API
Configuração: substituição da URL base e configuração do projeto TypeScript