Skip to content

Commit b98f2b1

Browse files
committed
remove deprecation notice
1 parent 7b70830 commit b98f2b1

File tree

3 files changed

+31
-24
lines changed

3 files changed

+31
-24
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
All notable changes to this project will be documented in this file.
44
This project adheres to Semantic Versioning.
55

6+
## 3.6.1 - 2025-12-14
7+
8+
### Added
9+
10+
- Remove deprecation notice. Add to readme
11+
612
## [3.6.0] - 2025-12-14
713

814
### Added

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,28 @@
22

33
#### Why Another [Paystack](https://paystack.com) Package?
44

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+
```
927

1028
### Installation
1129

@@ -19,31 +37,20 @@ For NPM
1937

2038
For Typescript
2139

22-
```typescript
23-
import {Paystack} from 'paystack-sdk';
24-
// or
40+
```ts
2541
import Paystack from 'paystack-sdk';
2642

27-
const paystack = new Paystack("secret_key");
43+
const paystack = new Paystack('secret_key');
2844
```
2945

3046
For Javscript
3147

32-
```javascript
33-
const Paystack = require('paystack-sdk').Paystack;
34-
// or
48+
```js
3549
const Paystack = require('paystack-sdk');
3650

3751
const paystack = new Paystack('secret_key');
3852
```
3953

40-
OR
41-
42-
```javascript
43-
const { Paystack } = require('paystack-sdk');
44-
const paystack = new Paystack('secret_key');
45-
```
46-
4754
All methods use promise meaning you can either use the `async...await` or `then...catch` or `try...catch`
4855

4956
### Modules

src/paystack.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,6 @@ import axios from 'axios';
2525
* @author Asaju Enitan <@tPriest>
2626
*/
2727

28-
/**
29-
* @deprecated This named export is deprecated and will be removed
30-
* in version `4.0.0`.
31-
* Use the default export instead:
32-
* Use `import Paystack from 'paystack-sdk'`
33-
*/
3428
export class Paystack {
3529
private readonly http: AxiosInstance;
3630
public bulkcharge: BulkCharge;

0 commit comments

Comments
 (0)