An open API service indexing awesome lists of open source software.

https://github.com/peterdee/js-classes

Examplary module
https://github.com/peterdee/js-classes

Last synced: 10 months ago
JSON representation

Examplary module

Awesome Lists containing this project

README

          

## Examplary module

**This is an examplary module, that is published to NPM.**

**Please ignore this, as this module does not provide any real functionality.**

This module uses [OpenDota API](https://docs.opendota.com) to search for players by player names.

[![Known Vulnerabilities](https://snyk.io/test/github/peterdee/js-classes/badge.svg?targetFile=package.json)](https://snyk.io/test/github/peterdee/js-classes?targetFile=package.json)

### Installation

```
npm i js-classes-examplary-module
```

### Usage

Create an instance of the module:

```
const Examplary = require('js-classes-examplary-module');
const Instance = new Examplary();
```

Then use it in some async function:

```
const players = await Instance.searchPlayers('some player name');
console.log(players);
```