npm 包 currencytf-api 使用教程

npm 包 currencytf-api 是一个用于查询货币汇率的 API 包。它提供了简单易用的接口,帮助开发者快速获取各种货币之间的汇率信息。本篇文章将详细介绍该 npm 包的使用方法,配合代码示例进行讲解,希望能够给前端开发者带来一些帮助。

安装

使用 npm 安装 currencytf-api:

引用

在需要使用该包的文件中,通过以下方式引用:

const currency = require('currencytf-api');

接口介绍

currencytf-api 提供了以下几个接口:

getRate(from, to)

获取指定货币之间的汇率。

参数:

  • from:string,源货币代码,例如 'USD'。
  • to:string,目标货币代码,例如 'EUR'。

返回值:

  • Promise 对象,成功时返回该货币对的汇率(float 值),失败时返回错误信息(string 值)。

示例代码:

currency.getRate('USD', 'EUR').then(rate => {
    console.log('USD to EUR rate: ' + rate);
}).catch(error => {
    console.error('Failed to get rate: ' + error);
});

getAllRates(base)

获取指定基准货币的所有汇率。

参数:

  • base:string,基准货币代码,默认为 'USD'。

返回值:

  • Promise 对象,成功时返回一个对象,该对象的键值对为货币代码和对应的汇率值。失败时返回错误信息(string 值)。

示例代码:

currency.getAllRates().then(rates => {
    for (const [code, rate] of Object.entries(rates)) {
        console.log(`${code}: ${rate}`);
    }
}).catch(error => {
    console.error('Failed to get rates: ' + error);
});

convert(amount, from, to)

将指定数量的货币从一个代码转换为另一个代码。

参数:

  • amount:number,转换数量。
  • from:string,源货币代码。
  • to:string,目标货币代码。

返回值:

  • Promise 对象,成功时返回转换后的金额(float 值),失败时返回错误信息(string 值)。

示例代码:

currency.convert(100, 'USD', 'GBP').then(result => {
    console.log('USD 100 equals GBP ' + result);
}).catch(error => {
    console.error('Failed to convert: ' + error);
});

使用示例

结合上述接口,可以实现如下的货币兑换代码:

const currency = require('currencytf-api');

currency.getAllRates('USD').then(rates => {
    // 等待汇率数据加载完毕
    const from = 'USD';
    const to = 'EUR';
    const amount = 100;

    const rate = rates[to];
    if (!rate) {
        console.error('Invalid target currency: ' + to);
        return;
    }

    currency.convert(amount, from, to).then(result => {
        console.log(`${amount} ${from} equals ${result} ${to}`);
    }).catch(error => {
        console.error('Failed to convert: ' + error);
    });
}).catch(error => {
    console.error('Failed to get rates: ' + error);
});

该代码的执行结果将输出类似于以下内容:

总结

currencytf-api 提供了简单易用的货币汇率查询接口,让前端开发人员可以轻松地获取各种货币之间的汇率信息。通过本文章的介绍和示例代码,在使用该包时应当没有太大的障碍。同时,在具体应用中,需要对数据的合法性、异常处理等方面加以关注,以保证代码的稳定可靠。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/600673ddfb81d47349e53b3f


纠错
反馈