node-imei/README.md

imei generator/checker

# node-imei
## Description
imei generator/checker (via Luhn algorithm)

## Installation
    $ npm install node-imei
    
## Usage
### Node environment

``` javascript
const { getRandom, getImeiByDevice, isValid } = require('node-imei');
```

### ESM
```typescript
import { getRandom, getImeiByDevice, isValid } from 'node-imei';
```

# Functions
```typescript
getRandom(); // returns string with random imei

getImeiByDevice("Apple","iPhone3G"); // returns string with imei by device TAC

isValid("860921035123120"); // returns true
```

### random()
Returns a string with valid imei. Script makes string with 3 parts:
1st part is TAC (Type Allocation Code)
2nd part is random value from 100000 to 999999
3rd part is last digit(Luhn digit)

### isValid(imei)
Returns a boolean value.
# Also
codes.ts contains json object with Type Allocation Codes.
## If you want to extend the file
Just add new TAC`s in codes.ts
More info and examples of TAC`s you can find at 
[wiki](https://en.wikipedia.org/wiki/Type_Allocation_Code)
or
[OSMOCOM direct link to download TACs db in json](http://tacdb.osmocom.org/export/tacdb.json)

# License

  [MIT](LICENSE)