Pincode To Address

pincode-to-address is an npm package that allows users to lookup address details (region, division, district, state) based on Indian pincodes.

Features

• Efficient pincode to address lookup.
• Preloaded data for quick access.
• Easy to use.

Installation

Install the package using npm:

npm i pincode-to-address
OR
yarn add pincode-to-address

Usage

Once the package is installed, you can import the library using import or require approach:

const { getPincodeData } = require('pincode-to-address'); 

try { 
   const address = getPincodeData(394101);
   console.log(address); 
} 
catch (error) {
 console.error(error.message); 
}

Sample Output

{
  region: 'Vadodara ',
  division: 'Surat ',
  pincode: '394101',
  district: 'SURAT',
  state: 'Gujarat'
}

Usage In React Component

Once the package is installed, you can import the library using import or require approach:

import React, { useState } from 'react';
import pincodeToAddress from 'pincode-to-address'; // Assuming the default export is the function to get the address

const PincodeLookup = () => {
  const [pincode, setPincode] = useState('');
  const [address, setAddress] = useState(null);
  const [error, setError] = useState('');

  const handlePincodeChange = (event) => {
    setPincode(event.target.value);
  };

  const lookupAddress = async () => {
    try {
      const result = await pincodeToAddress(pincode);
      setAddress(result);
      setError('');
    } catch (err) {
      setAddress(null);
      setError(err.message);
    }
  };

  return (
    <div>
      <h1>Pincode to Address Lookup</h1>
      <input
        type="text"
        value={pincode}
        onChange={handlePincodeChange}
        placeholder="Enter pincode"
      />
      <button onClick={lookupAddress}>Lookup Address</button>
      {error && <p style={{ color: 'red' }}>{error}</p>}
      {address && (
        <div>
          <h2>Address Details:</h2>
          <p><strong>State:</strong> {address.state}</p>
          <p><strong>District:</strong> {address.district}</p>
          <p><strong>Locality:</strong> {address.locality}</p>
        </div>
      )}
    </div>
  );
};

export default PincodeLookup;

Test Cases

| Input | Output | | ----------------- | ------------------------------------------------------------------ | | XXXXXX (6 digit pincode) |{ region: 'Vadodara ', || division: 'Surat ', ||pincode: '394101', || district: 'SURAT', || state: 'Gujarat' } | | Any digit number (excluding 6 digit) OR |Invalid Pincode.| Non-existing pincode||

License

Author

Om beladiya