africastalking-ts
Unofficial Typescript version of the Africa's Talking SDK
Install
npm i africastalking-ts
Quick Start Example: Send an SMS
This example creates an Africa's Talking Client, and sends an SMS to two phone numbers.
; ; client.sendSms .thenconsole.logresponse .catchconsole.logerror;
Links
- SDK Reference (available functions, constants, types for Typescript, etc)
- Code examples
- Rest API Reference
Development
# install npm modules npm i # eslint npm run lint # typescript check npm run ts-check # test npm t # build npm run build
Note: This is a breaking version
Please note that this Typescript SDK has breaking changes from the Javascript version. It greatly changes its usage, and you will need to update your codebase to avoid errors.
const credentials = apiKey: 'YOUR_API_KEY' username: 'YOUR_USERNAME' ; // previously:const africastalking = credentials;const sms = africastalkingSMS;sms; // now:; // or const { Client } = require('africastalking');const client = credentials;client;
You can find the complete list of new function names here.
However, we understand that updating the bulk of your code can be tedious, so we have given you a way to incrementally upgrade to the new version.
To use the new version, whilst still keeping the old function calls, you only need to update your require statements as follows (the key word is .default
):
const africastalking = ;const sms = africastalkingSMS;sms;
However, please note that even this way is altogether being deprecated and will be removed in future versions. Kindly make an effort to rewrite your codebase using the newer syntax.
Alternatively, you can just use the Javascript version of the SDK in your codebase.
Pull Requests
Any and all PRs are open.