DZ-WILAYA 🇩🇿

A comprehensive JavaScript library for managing Algerian Wilayas (provinces) data.

📦 Installation

npm install dz-wilaya

🚀 Usage

const { 
  getAllWilayas, 
  getWilayaByCode, 
  getWilayasByRegion,
  validateWilayaCode 
} = require('dz-wilaya');

// Get all wilayas
const allWilayas = getAllWilayas();

// Get a specific wilaya by code
const algiers = getWilayaByCode("16");
console.log(algiers); 
// { code: "16", name: "Alger", ar_name: "الجزائر", region: "Nord", capital: "Alger", codePostal: "16000" }

// Get wilayas by region
const northWilayas = getWilayasByRegion("Nord");

📚 API Reference

getAllWilayas()

Returns an array of all 58 Algerian wilayas.

Returns: Array<Object>

getWilayaByCode(code)

Find a wilaya by its code.

Parameters:

• code (String): The wilaya code (e.g., "01", "16")

Returns: Object | undefined

Example:

getWilayaByCode("01"); // Returns Adrar

getWilayaByName(name)

Find a wilaya by its name (case-insensitive).

Parameters:

• name (String): The wilaya name (e.g., "Alger", "Oran")

Returns: Object | undefined

Example:

getWilayaByName("Alger"); // Returns Alger wilaya

getWilayaByArName(ar_name)

Find a wilaya by its Arabic name.

Parameters:

• ar_name (String): The Arabic name (e.g., "الجزائر", "وهران")

Returns: Object | undefined

Example:

getWilayaByArName("الجزائر"); // Returns Alger wilaya

getWilayasByRegion(region)

Get all wilayas in a specific region (case-insensitive).

Parameters:

• region (String): The region name ("Nord", "Sud", "Est", "Ouest")

Returns: Array<Object>

Example:

getWilayasByRegion("Sud"); // Returns all southern wilayas

getWilayaByCapital(capital)

Find a wilaya by its capital city (case-insensitive).

Parameters:

• capital (String): The capital name (e.g., "Alger", "Oran")

Returns: Object | undefined

Example:

getWilayaByCapital("Oran"); // Returns Oran wilaya

getWilayaByPostalCode(codePostal)

Find a wilaya by its postal code.

Parameters:

• codePostal (String): The postal code (e.g., "16000")

Returns: Object | undefined

Example:

getWilayaByPostalCode("16000"); // Returns Alger wilaya

checkCodePostalWilayaMatch(code, codePostal)

Verify if a wilaya code matches with a postal code.

Parameters:

• code (String): The wilaya code
• codePostal (String): The postal code

Returns: Boolean

Example:

checkCodePostalWilayaMatch("16", "16000"); // true
checkCodePostalWilayaMatch("16", "01000"); // false

validateWilayaCode(code)

Validate if a wilaya code is valid.

Parameters:

• code (String | Number): The wilaya code to validate

Returns: Boolean

Example:

validateWilayaCode("16");  // true
validateWilayaCode(5);     // true (converted to "05")
validateWilayaCode("99");  // false
validateWilayaCode("abc"); // false

📊 Data Structure

Each wilaya object contains:

{
  code: "16",           // Wilaya code (2 digits)
  name: "Alger",        // French name
  ar_name: "الجزائر",   // Arabic name
  region: "Nord",       // Region (Nord, Sud, Est, Ouest)
  capital: "Alger",     // Capital city
  codePostal: "16000"   // Postal code
}

🌍 Regions

• Nord (North): Coastal wilayas
• Sud (South): Saharan wilayas
• Est (East): Eastern wilayas
• Ouest (West): Western wilayas

📝 License

ISC

👤 Author

Nabil GHENISSA

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Made with ❤️ for Algeria 🇩🇿