# @mstuessypp/rfid-api-js

> A JavaScript API wrapper for the Pod Point RFID API.

Latest version **1.0.3-debug-5** (published 2020-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mstuessypp/rfid-api-js
pnpm add @mstuessypp/rfid-api-js
yarn add @mstuessypp/rfid-api-js
bun add @mstuessypp/rfid-api-js
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3-debug-5 |
| Published | 2020-02-19 |
| First published | 2020-02-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 44.2 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | Pod Point Software Team |
| Maintainers | mstuessypp |
| Keywords | TypeScript |

## Links

- npm: https://www.npmjs.com/package/@mstuessypp/rfid-api-js
- Repository: https://github.com/Pod-Point/rfid-api-js
- Homepage: https://github.com/Pod-Point/rfid-api-js#readme
- Issues: https://github.com/Pod-Point/rfid-api-js/issues
- npm.io page: https://npm.io/package/@mstuessypp/rfid-api-js

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [faker](https://npm.io/package/faker.md) ^4.1.0
- [@types/faker](https://npm.io/package/@types/faker.md) ^4.1.4
- [@mstuessypp/typescript](https://npm.io/package/@mstuessypp/typescript.md) 1.3.0-debug-3

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.3-debug-5 (latest) — 2020-02-19
- 1.0.3-debug-4 — 2020-02-19
- 1.0.3-debug-3 — 2020-02-19

## README

# Pod Point RFID API SDK (JS)

[![Build Status](https://travis-ci.com/Pod-Point/rfid-api-js.svg?token=73ppRJ3n2qFqCAyLsSAu&branch=master)](https://travis-ci.com/Pod-Point/rfid-api-js)
[![codecov](https://codecov.io/gh/Pod-Point/rfid-api-js/branch/master/graph/badge.svg?token=i3aGnvrNyL)](https://codecov.io/gh/Pod-Point/rfid-api-js)
[![npm](https://img.shields.io/npm/v/@pod-point/rfid-api-js.svg)](https://www.npmjs.com/package/@pod-point/rfid-api-js)

A JavaScript wrapper for the Pod Point RFID API built with TypeScript.

## Installation

To install this package, run the following command:
```bash
npm install --save @pod-point/rfid-api-js
```

## Usage

This package contains a client, repositories, services, models and factories.

### Client

First, you will want to create a new client instance.

```js
// path/to/client.js
import { Client } from '@pod-point/rfid-api-js';

const client = new Client(userAgent, domain, prefix);
```

### Repositories & Services

Next, you can start creating and using repository and service instances with the client you have just created.

```js
// path/to/anywhere.js
import { CardRepository } from '@pod-point/rfid-api-js';
import client from 'path/to/client';

const cardRepository = new CardRepository(client);
```

### Factories

Lastly, you can use the factories to create fake resources.

```js
import { CardFactory } from '@pod-point/rfid-api-js';

const cardFactory = new CardFactory();
const fakeCard = cardFactory.make();
```

## Development

### Testing

This package uses jest. To run the test suites for this project, run the following command:

```bash
npm run test
```

### Releases

This package is distributed via NPM and published automatically by Travis when creating a tagged commit. This can be done in one of 2 ways:

#### 1. Pre-merge via the CLI

**Before** merging your PR following code review & QA, run the following commands to update the package version and create a new release/tag.
```
npm version <major|minor|patch|prerelease>
git push && git push --tags
```

If you forget to do this before merging, this is not a problem, just create a new branch from master and run these same commands, remembering to open and merge a PR for this branch so that the `package.json` file is updated, alternatively, see option 2.

#### 2. Post-merge via code & GitHub

**After** merging your code changes, create a new branch/PR from master and update the package version in `package.json` to whatever you wish the next release to be.

**Before** merging this PR, create a release via GitHub with a tag version to match this package version number, this will trigger the tagged commit and in turn the automatic deployment to NPM.

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