Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typescript rewrite #143

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .eslintignore

This file was deleted.

54 changes: 0 additions & 54 deletions .eslintrc

This file was deleted.

26 changes: 16 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# IDE
.vscode

# OS
.DS_Store

# Node
node_modules
logs
*.log
pids
*.pid
*.seed

# Coverage
lib-cov
coverage
.grunt
.idea
_builds
_projects
_steps
coverage-ts

# Built files
dist
*.tgz

# Docs
docs
14 changes: 8 additions & 6 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
{
"source": {
"include": [
"index.js",
"dist/index.js",
"README.md"
]
},
"templates": {
"default": {
"outputSourceFiles": false,
"useLongnameInNav": true
"outputSourceFiles": false,
"useLongnameInNav": true
}
},
"plugins": [
"plugins/markdown"
"plugins/markdown"
],
"markdown": {
"tags": [ "description" ]
"tags": [
"description"
]
},
"opts": {
"destination": "./docs",
"encoding": "utf8",
"template": "./node_modules/@edwellbrook/minami"
}
}
}
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Pull requests are always very welcome.

Install with [npm](https://npmjs.org/):

``` shell
npm install --save node-tvdb
```shell
npm i node-tvdb
```

And run tests with [Mocha](https://mochajs.org):

``` shell
```shell
TVDB_KEY=[YOUR API KEY HERE] npm test
```

Expand All @@ -36,9 +36,10 @@ TVDB_KEY=[YOUR API KEY HERE] npm test

To start using this library you first need an API key. You can request one [here](http://thetvdb.com/?tab=apiregister). Then just follow this simple example that fetches all the shows containing "The Simpsons" in the name.

``` javascript
const TVDB = require('node-tvdb');
const tvdb = new TVDB('ABC123');
```ts
import { TheTVDB } from 'node-tvdb';

const tvdb = new TheTVDB('ABC123');

tvdb.getSeriesByName('The Simpsons')
.then(response => { /* process data */ })
Expand Down
Loading