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.

Sign up for GitHub

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

Jump to bottom

Add TypeScript usage docs with response type #2

Merged
merged 1 commit into from
Jan 23, 2020
Merged

Add TypeScript usage docs with response type #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,26 @@ dbWatcher.on('update', () => {
dbWatcher.close();
```

### Usage with TypeScript

This package includes its own types and you can pass the response type in `open`:

```ts
import geolite2 from 'geolite2-redist';
import maxmind, { CityResponse } from 'maxmind';

(async () => {
let lookup = await geolite2.open<CityResponse>('GeoLite2-City', path => {
return maxmind.open(path);
});

let city = lookup.get('66.6.44.4');

// Call this when done to empty node's event loop
lookup.close();
})();
```

## API

### Methods
Expand Down