Place by National ID

getPlaceByIranNationalId(nationalId?: string): IPlaceByNationalId | null | undefined

import { getPlaceByIranNationalId } from "@persian-tools/persian-tools";

getPlaceByIranNationalId("0084575948");
// { codes: [...], city: "تهران مرکزی", province: "تهران" }

getPlaceByIranNationalId("0000000000"); // null  — prefix "000" not in the dataset
getPlaceByIranNationalId(undefined); // undefined
getPlaceByIranNationalId(""); // undefined

interface IPlaceByNationalId {
	codes: number[] | string[]; // all 3-digit codes mapped to this city
	city: string;
	province: string; // may be "unknown" if the parent code is missing
}

import { verifyIranianNationalId, getPlaceByIranNationalId } from "@persian-tools/persian-tools";

const safeLookup = (id: string) => (verifyIranianNationalId(id) ? getPlaceByIranNationalId(id) : null);