igorsilva3 / pagarme-js-types

📖 A simple typescript definition file for pagarme-js repository

Pagar.me JavaScript Types

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 and official pagarme-js documentation

🤔 How to use?

1. Install the package as devDependencies using npm or yarn

npm install --save-dev pagarme-js-types

2. Include the package into your tsconfig.json file

// 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:

// src/@types/pagarme.d.ts
import 'pagarme-js-types/src/index';

See more in the handbook.

💪 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

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

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

• all
• capture
• create
• find
• refund
• calculateInstallmentsAmount

Postback

• calculateSignature
• verifySignature

Refunds

• find

Validations

• validate

Security

• encrypt

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Rafael Farias 💻	Jonathan Célio 💻 📖 👀 🧑‍🏫	Murilo Maia 💻	Ítalo Andrade 💻 📖	Raffael Campos 💻 📖	Rodrigo Venâncio Veríssimo 💻 📖	Arthur Abrantes 💻 📖
Sidinei Silva 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!