paystack-sdk 3.5.0 → 3.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +25 -18
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -2,10 +2,28 @@
2
2
 
3
3
  #### Why Another [Paystack](https://paystack.com) Package?
4
4
 
5
- Existing Paystack libraries are either outdated, lack modern features, or fail to support TypeScript. This package addresses these gaps by providing:
6
- - Full TypeScript support for type safety and better developer experience.
7
- - A modern, actively maintained library aligned with Paystack’s latest API updates.
8
- - Clean, intuitive APIs designed for ease of use.
5
+ Existing Paystack libraries are either outdated, lack modern features, or fail to support TypeScript. This package addresses these gaps by providing:
6
+
7
+ - Full TypeScript support for type safety and better developer experience.
8
+ - A modern, actively maintained library aligned with Paystack’s latest API updates.
9
+ - Clean, intuitive APIs designed for ease of use.
10
+
11
+ ## Deprecation Notice
12
+
13
+ Named import will be removed in version 4.0.0. Migrate to default import.
14
+ Change
15
+
16
+ ```ts
17
+ import { Paystack } from 'paystack-sdk';
18
+ const Paystack = require('paystack-sdk').Paystack;
19
+ ```
20
+
21
+ To
22
+
23
+ ```ts
24
+ import Paystack from 'paystack-sdk';
25
+ const Paystack = require('paystack-sdk');
26
+ ```
9
27
 
10
28
  ### Installation
11
29
 
@@ -19,31 +37,20 @@ For NPM
19
37
 
20
38
  For Typescript
21
39
 
22
- ```typescript
23
- import {Paystack} from 'paystack-sdk';
24
- // or
40
+ ```ts
25
41
  import Paystack from 'paystack-sdk';
26
42
 
27
- const paystack = new Paystack("secret_key");
43
+ const paystack = new Paystack('secret_key');
28
44
  ```
29
45
 
30
46
  For Javscript
31
47
 
32
- ```javascript
33
- const Paystack = require('paystack-sdk').Paystack;
34
- // or
48
+ ```js
35
49
  const Paystack = require('paystack-sdk');
36
50
 
37
51
  const paystack = new Paystack('secret_key');
38
52
  ```
39
53
 
40
- OR
41
-
42
- ```javascript
43
- const { Paystack } = require('paystack-sdk');
44
- const paystack = new Paystack('secret_key');
45
- ```
46
-
47
54
  All methods use promise meaning you can either use the `async...await` or `then...catch` or `try...catch`
48
55
 
49
56
  ### Modules
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "paystack-sdk",
3
- "version": "3.5.0",
3
+ "version": "3.6.1",
4
4
  "description": "Paystack SDK written in Typescript",
5
5
  "main": "dist/index.js",
6
6
  "author": "Tech Priest",
@@ -40,7 +40,9 @@
40
40
  "Paystack",
41
41
  "Typescript",
42
42
  "payment",
43
- "node"
43
+ "node",
44
+ "API",
45
+ "naira"
44
46
  ],
45
47
  "repository": {
46
48
  "type": "git",