Kurlar

Türkiye Cumhuriyet Merkez Bankası (TCMB) tarafından yayınlanan döviz kurlarını kolayca çekmenizi sağlayan bir TypeScript kütüphanesi.

Özellikler

• TCMB'nin günlük döviz kurlarını çekme
• Tarihe göre döviz kuru sorgulama
• JSON formatında sonuç döndürme
• TypeScript desteği ile güçlü tip kontrolü

Kurulum

Projeyi kullanmaya başlamak için aşağıdaki adımları izleyin:

yarn add kurlar

Kullanım

Aşağıdaki örnek, kütüphanenin nasıl kullanılacağını göstermektedir:

import { fetchCurrency } from "kurlar";

(async () => {
  const result = await fetchCurrency({
    currency: "USD",
    date: new Date("2023-10-26"),
  });

  console.log(result);
})();

import { fetchAllCurrencies } from "kurlar";

(async () => {
  try {
    const allCurrencies = await fetchAllCurrencies(new Date("2023-10-26"));

    if (allCurrencies) {
      console.log("Tüm döviz kurları:", allCurrencies);
    } else {
      console.log("Belirtilen tarihte döviz kurları bulunamadı.");
    }
  } catch (error) {
    console.error("Döviz kurları alınırken bir hata oluştu:", error);
  }
})();

Döviz Kodu Listesi

USD, AUD, DKK, EUR, GBP, CHF, SEK, CAD, KWD, NOK, SAR, JPY, BGN, RON, RUB, CNY, PKR, QAR, KRW, AZN, AED

API

fetchCurrency({ currency, date }): Promise<TCMBResponseType | null>

• currency: Döviz kodu (ör. "USD", "EUR")
• date: Tarih (opsiyonel, belirtilmezse bugünün tarihi kullanılır)

Dönen değer, aşağıdaki yapıya sahiptir:

type TCMBResponseType = {
  Unit: number;
  CurrencyName: string;
  CurrencyCode: string;
  ForexBuying: number;
  ForexSelling: number;
  BanknoteBuying: number;
  BanknoteSelling: number;
};

Testler

Testleri çalıştırmak için:

yarn test

Kod kapsamını görmek için:

yarn test:coverage

Katkıda Bulunma

Katkıda bulunmak isterseniz, lütfen bir pull request gönderin veya bir issue açın.

Lisans

Bu proje MIT ile lisanslanmıştır.