Class Reader

Class representing the mmdb reader *

Index

Constructors

Methods

open openBuffer

Constructors

constructor

new Reader(): Reader
Returns Reader

Methods

`Static`open

open(file: string, opts?: OpenOpts): Promise<ReaderModel>
Opens a mmdb file and returns a ReaderModel promise
Parameters
- file: string
  The file to open
- Optionalopts: OpenOpts
  Options for opening the file. See https://github.com/runk/node-maxmind#options
Returns Promise<ReaderModel>
Example
```
Reader.open('somefile.mmdb').then(reader => {
  const response = reader.city('123.123.123.123')
  console.log(response.city) // The city object (maxmind.CityField)
  console.log(response.country) // The country object (maxmind.CountryField)
});
```
- Defined in src/reader.ts:22

`Static`openBuffer

openBuffer(buffer: Buffer): ReaderModel
Opens a buffer that contains mmdb data and returns a ReaderModel
Parameters
- buffer: Buffer
  The buffer to open
Returns ReaderModel
- Defined in src/reader.ts:31