インストール
npmからlistingsapi-jsをインストールし、ESMまたはCJSを選択して、セットアップを確認します。
要件
- Node.js 18 以降
- npm、pnpm、または yarn
SDK はネイティブの fetch（Node 18 以降に組み込み）を使用し、実行時の依存関係はありません。
インストール
npm install listingsapi-js# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-jsESM と 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