https://github.com/peterdee/ts-classes
Examplary module with Typescript
https://github.com/peterdee/ts-classes
Last synced: over 1 year ago
JSON representation
Examplary module with Typescript
- Host: GitHub
- URL: https://github.com/peterdee/ts-classes
- Owner: peterdee
- Created: 2019-12-31T20:18:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-16T09:00:43.000Z (about 5 years ago)
- Last Synced: 2025-01-21T10:11:14.063Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ts-classes-examplary-module
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Examplary module
**This is an examplary module with Typescript, 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 load all of the available Dota 2 heroes.
[](https://travis-ci.com/peterdee/ts-classes)
[](https://snyk.io/test/github/peterdee/ts-classes?targetFile=package.json)
### Installation
```bash
npm i ts-classes-examplary-module
```
### Usage
Create an instance of the module:
```javascript
const { DotaHeroes } = require('ts-classes-examplary-module');
const Instance = new DotaHeroes();
```
Then use it to load the available heroes list with the `getHeroes` method:
```javascript
const heroes = await Instance.getHeroes();
console.log(heroes);
```