# pagarme-js-type

> [![npm (scoped)](https://img.shields.io/npm/v/pagarme-js-type.svg)](https://www.npmjs.com/package/pagarme-js-type) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-

Latest version **1.0.1** (published 2020-07-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install pagarme-js-type
pnpm add pagarme-js-type
yarn add pagarme-js-type
bun add pagarme-js-type
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-07-20 |
| First published | 2020-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 52 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 44 |
| Author | Jonathan Célio |
| Maintainers | jonycelio |

## Links

- npm: https://www.npmjs.com/package/pagarme-js-type
- Repository: https://github.com/jonyw4/pagarme-js-type
- Homepage: https://github.com/jonyw4/pagarme-js-type#readme
- Issues: https://github.com/jonyw4/pagarme-js-type/issues
- npm.io page: https://npm.io/package/pagarme-js-type

## Recent versions

- 1.0.1 (latest) — 2020-07-20
- 1.0.0 — 2020-07-20

## README

# Pagar.me JavaScript Types
[![npm (scoped)](https://img.shields.io/npm/v/pagarme-js-type.svg)](https://www.npmjs.com/package/pagarme-js-type)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

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](https://docs.pagar.me/reference)** and **[official pagarme-js documentation](https://pagarme.github.io/pagarme-js/)**

## What are declaration files?

See the [TypeScript handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html).

## How do I get them?

### npm

This is the preferred method. For example:

```sh
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:

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

See more in the [handbook](http://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html).

## 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

### Postback
- [x] calculateSignature
- [x] verifySignature

### Refunds 
- [x] find

---
_Source: https://npm.io/package/pagarme-js-type · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._