설치

npm에서 listingsapi-js를 설치하고, ESM 또는 CJS를 선택한 다음 설정을 확인합니다.

요구 사항

• Node.js 18 이상
• npm, pnpm 또는 yarn

SDK는 네이티브 fetch(Node 18 이상에 내장)를 사용하며 런타임 의존성이 없습니다.

• 소스: github.com/listings-api/listingsapi-nodejs-sdk
• 릴리스: npmjs.com/package/listingsapi-js

설치

npm install listingsapi-js

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

ESM과 CJS

listingsapi-js에는 ESM 빌드와 CommonJS 빌드가 모두 포함되어 있습니다. 프로젝트의 type 설정에 따라 적절한 진입점이 자동으로 선택됩니다.

ESM(package.json의 "type": "module" 설정 또는 .mts/.mjs 확장자):

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

CJS(기본 Node 모듈 해석 방식 또는 .cts/.cjs 확장자):

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

TypeScript

타입 정의가 패키지에 포함되어 있으므로 별도의 @types/listingsapi-js가 필요하지 않습니다. SDK는 TypeScript로 작성되었으며, dist/ 폴더에는 모든 내보내기 항목에 대한 .d.ts 파일과 CommonJS 빌드용 .d.cts 파일이 포함되어 있습니다.

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

버전 고정

이 문서는 listingsapi-js 0.3.2로 테스트되었습니다.

npm install listingsapi-js@0.3.2

또는 package.json에서 다음과 같이 설정합니다:

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

확인

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

다음 단계

• 빠른 시작: 연결하고 첫 API 호출 실행하기
• 구성: 기본 URL 재정의 및 TypeScript 프로젝트 설정