open-index/open-npm huggingface dataset:
npm package: @mstuessypp/cache-js
Description: A cache service for JS.
Author: Pod Point Software Team
Latest version: 1.0.1-5-2

# Cache JS

[![Build Status](https://travis-ci.com/Pod-Point/cache-js.svg?branch=master)](https://travis-ci.com/Pod-Point/cache-js)
[![codecov](https://codecov.io/gh/Pod-Point/cache-js/branch/master/graph/badge.svg)](https://codecov.io/gh/Pod-Point/cache-js)

A cache service for JS.

## Usage

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

Once installed, simply create a new instance of the Cache service and begin using it e.g.
```
import { Redis } from '@pod-point/cache-js';

const cacheService = new Redis();

await cacheService.put('foo', 'bar');
```

There are only 3 simple methods a cache service can carry out, and these are `put`, `get` and `remove`, all fairly self-explanatory!

When putting key/value pairs into the cache you can also set an expiry date, or a time in seconds until it should expire.

## Development

### Installation

To install this packages dependencies, run the following command:
```bash
npm install
```

### 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.
npm package: @mstuessypp/rfid-api-js
Description: A JavaScript API wrapper for the Pod Point RFID API.
Author: Pod Point Software Team
Latest version: 1.0.3-debug-5

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