DigiPin

A JavaScript/TypeScript library for India Post's Geospatial Addressing Solution. This library provides methods to encode and decode DigiPins - a 10-character alphanumeric code that represents a unique geographical location in India.

Installation

``bash
npm install digipin
`

Usage

$3

`javascript
const { getDigiPin, getLatLngFromDigiPin } = require('digipin');

// Convert latitude and longitude to DigiPin
const digiPin = getDigiPin(28.6139, 77.209); // Delhi coordinates
console.log(digiPin); // Returns formatted DigiPin like "ABC-DEF-GHIJ"

// Convert DigiPin back to coordinates
const coordinates = getLatLngFromDigiPin('ABC-DEF-GHIJ');
console.log(coordinates); // { latitude: "28.613900", longitude: "77.209000" }
`

$3

`typescript
import { getDigiPin, getLatLngFromDigiPin } from 'digipin';

// Convert latitude and longitude to DigiPin
const digiPin = getDigiPin(28.6139, 77.209); // Delhi coordinates
console.log(digiPin); // Returns formatted DigiPin like "ABC-DEF-GHIJ"

// Convert DigiPin back to coordinates
const coordinates = getLatLngFromDigiPin('ABC-DEF-GHIJ');
console.log(coordinates); // { latitude: "28.613900", longitude: "77.209000" }
`

API Reference

$3

Converts latitude and longitude coordinates to a DigiPin.

- Parameters:
- lat (number): Latitude value between 2.5 and 38.5
- lon (number): Longitude value between 63.5 and 99.5
- Returns: A formatted DigiPin string (e.g., "ABC-DEF-GHIJ")
- Throws: Error if latitude or longitude is out of range

$3

Converts a DigiPin back to its corresponding coordinates.

- Parameters:
- digiPin` (string): A 10-digit DigiPin string (with or without hyphens)
- Returns: Object containing the decoded latitude and longitude as strings
- Throws: Error if DigiPin format is invalid

Geographic Coverage

This library works for coordinates within India's geographic bounds:

- Latitude: 2.5°N to 38.5°N
- Longitude: 63.5°E to 99.5°E

License

ISC

Author

Amit Kumar