https://github.com/jonyw4/pagarme-js-types
📖 A simple typescript definition file for pagarme-js repository
https://github.com/jonyw4/pagarme-js-types
javascript pagar-me pagarme pagarme-js type types typescript
Last synced: 10 days ago
JSON representation
📖 A simple typescript definition file for pagarme-js repository
- Host: GitHub
- URL: https://github.com/jonyw4/pagarme-js-types
- Owner: jonyw4
- License: apache-2.0
- Created: 2020-07-20T17:24:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2026-05-28T19:47:50.000Z (14 days ago)
- Last Synced: 2026-05-28T21:21:50.980Z (13 days ago)
- Topics: javascript, pagar-me, pagarme, pagarme-js, type, types, typescript
- Language: TypeScript
- Homepage:
- Size: 419 KB
- Stars: 44
- Watchers: 0
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pagar.me JavaScript Types
[](#contributors-)
A **unofficial repository** for adding typing / typescript compatibility for Pagar.me JS Client.
It's a **work in progress**. All type definition are take from the **[official documentation API Pagar.me V4](https://docs.pagar.me/reference)** and **[official pagarme-js documentation](https://pagarme.github.io/pagarme-js/)**
## 🤔 How to use?
1. Install the package as `devDependencies` using `npm` or `yarn`
```sh
npm install --save-dev pagarme-js-types
```
2. Include the package into your `tsconfig.json` file
```json
// tsconfig.json
...
"include": [
"node_modules/pagarme-js-types/index.d.ts"
]
...
```
Or if that doesn't work for you, instead of changing the tsconfig.json file,
just create the following file:
```ts
// src/@types/pagarme.d.ts
import 'pagarme-js-types/src/index';
```
See more in the [handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html).
## 💪 How to contribute
Thanks for give support to this project. To contribute you need to create a fork of this repo and send a Pull Request. Every contributor is mentioned at [Contributors list](#Contributors)
### Structure
All the code are in the `src` folder that follows the same location of Pagar.me lib.
Each *"module"* of Pagar.me lib is a folder that contains at least:
- `namespace.ts`: declaration of functions inside of a module
- `options.ts`: interfaces of the functions options
- `response.ts`: interfaces of the functions responses
Shared interfaces are in the folder called `common` in `src` root.
### Commits
This projects uses [commit lint to checks commit message](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)
### Sending a PR
Just explains what you are changing and why. I will love if you sent where did you get this information too. Thanks 😍
## To do
You can create a PR to contribute, for now these functions are typed:
### Transactions
- [x] all
- [x] capture
- [x] create
- [x] find
- [x] refund
- [x] calculateInstallmentsAmount
### Postback
- [x] calculateSignature
- [x] verifySignature
### Refunds
- [x] find
### Validations
- [x] validate
### Security
- [x] encrypt
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Rafael Farias
💻
Jonathan Célio
💻 📖 👀 🧑🏫
Murilo Maia
💻
Ítalo Andrade
💻 📖
Raffael Campos
💻 📖
Rodrigo Venâncio Veríssimo
💻 📖
Arthur Abrantes
💻 📖
Sidinei Silva
🐛
Igor Silva
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!