KiriminAja Node.js SDK

Requirements

• Node.js 18+ (has built-in fetch), or provide fetch via KiriminAja.init({ fetch })

Installation

npm install kiriminaja

yarn add kiriminaja

pnpm add kiriminaja

bun add kiriminaja

Setup

Initialize once, then use any endpoint.

import KiriminAja, { KAEnv } from "kiriminaja";

KiriminAja.init({
    env: KAEnv.SANDBOX, // or KAEnv.PRODUCTION
    apiKey: process.env.KIRIMINAJA_API_KEY,
});

If you need to override the base URL:

KiriminAja.init({
    baseUrl: "https://tdev.kiriminaja.com",
    apiKey: process.env.KIRIMINAJA_API_KEY,
});

If you are on Node.js < 18, pass a fetch implementation:

import KiriminAja from "kiriminaja";

KiriminAja.init({
    apiKey: process.env.KIRIMINAJA_API_KEY,
    fetch, // provide your own fetch polyfill
});

Usage

Coverage area:

const provinces = await KiriminAja.address.provinces();
const cities = await KiriminAja.address.cities(5);

Order:

const tracking = await KiriminAja.order.express.track("ORDER_ID");
const instantTracking = await KiriminAja.order.instant.track("ORDER_ID");

Development

To install dependencies:

bun install

To run:

bun run index.ts

This project was created using bun init in bun v1.3.3. Bun is a fast all-in-one JavaScript runtime.