pagarme-js-type

Pagar.me JavaScript Types

A unofficial repository for adding typing / typescript compatibility for Pagar.me.

It's a work in progress. All type definition are take from the official documentation API Pagar.me V4 and official pagarme-js documentation

What are declaration files?

See the TypeScript handbook.

How do I get them?

npm

This is the preferred method. For example:

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

The types should then be automatically included by the compiler. You may need to add a types reference if you're not using modules:

/// <reference types="pagarme-js-types" />

See more in the handbook.

To do

You can create a PR to contribute for now these functions are typed:

Transactions

• all
• capture
• create
• find
• refund

Postback

• calculateSignature
• verifySignature

Refunds

• find