diff --git a/docs/functions/src.castCityCode.html b/docs/functions/src.castCityCode.html
index 6f473b0..bf4f9bd 100644
--- a/docs/functions/src.castCityCode.html
+++ b/docs/functions/src.castCityCode.html
@@ -1,4 +1,4 @@
-
castCityCode | turkey-neighbourhoods - v3.0.8
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns "" | "Adana" | "Adıyaman" | "Afyonkarahisar" | "Ağrı" | "Aksaray" | "Amasya" | "Ankara" | "Antalya" | "Ardahan" | "Artvin" | "Aydın" | "Balıkesir" | "Bartın" | "Batman" | "Bayburt" | "Bilecik" | "Bingöl" | "Bitlis" | "Bolu" | "Burdur" | "Bursa" | "Çanakkale" | "Çankırı" | "Çorum" | "Denizli" | "Diyarbakır" | "Düzce" | "Edirne" | "Elazığ" | "Erzincan" | "Erzurum" | "Eskişehir" | "Gaziantep" | "Giresun" | "Gümüşhane" | "Hakkari" | "Hatay" | "Iğdır" | "Isparta" | "İstanbul" | "İzmir" | "Kahramanmaraş" | "Karabük" | "Karaman" | "Kars" | "Kastamonu" | "Kayseri" | "Kırıkkale" | "Kırklareli" | "Kırşehir" | "Kilis" | "Kocaeli" | "Konya" | "Kütahya" | "Malatya" | "Manisa" | "Mardin" | "Mersin" | "Muğla" | "Muş" | "Nevşehir" | "Niğde" | "Ordu" | "Osmaniye" | "Rize" | "Sakarya" | "Samsun" | "Siirt" | "Sinop" | "Sivas" | "Şanlıurfa" | "Şırnak" | "Tekirdağ" | "Tokat" | "Trabzon" | "Tunceli" | "Uşak" | "Van" | "Yalova" | "Yozgat" | "Zonguldak"
+Defined in src/index.ts:64
@@ -31,7 +31,7 @@
threshold : limit : number = 100
Returns { code : "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67" ; distance : number ; } []
+Defined in src/index.ts:83
@@ -29,7 +29,7 @@
code1 : code2 : "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67"
Returns undefined | number
+Defined in src/index.ts:72
@@ -22,7 +22,7 @@
Function getCities
Returns CityListItem []
+Defined in src/index.ts:113
@@ -22,7 +22,7 @@
Function getCityCodes
Returns ( "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67" ) []
+Defined in src/index.ts:109
@@ -22,7 +22,7 @@
Function getCityNames
Returns ( "Adana" | "Adıyaman" | "Afyonkarahisar" | "Ağrı" | "Aksaray" | "Amasya" | "Ankara" | "Antalya" | "Ardahan" | "Artvin" | "Aydın" | "Balıkesir" | "Bartın" | "Batman" | "Bayburt" | "Bilecik" | "Bingöl" | "Bitlis" | "Bolu" | "Burdur" | "Bursa" | "Çanakkale" | "Çankırı" | "Çorum" | "Denizli" | "Diyarbakır" | "Düzce" | "Edirne" | "Elazığ" | "Erzincan" | "Erzurum" | "Eskişehir" | "Gaziantep" | "Giresun" | "Gümüşhane" | "Hakkari" | "Hatay" | "Iğdır" | "Isparta" | "İstanbul" | "İzmir" | "Kahramanmaraş" | "Karabük" | "Karaman" | "Kars" | "Kastamonu" | "Kayseri" | "Kırıkkale" | "Kırklareli" | "Kırşehir" | "Kilis" | "Kocaeli" | "Konya" | "Kütahya" | "Malatya" | "Manisa" | "Mardin" | "Mersin" | "Muğla" | "Muş" | "Nevşehir" | "Niğde" | "Ordu" | "Osmaniye" | "Rize" | "Sakarya" | "Samsun" | "Siirt" | "Sinop" | "Sivas" | "Şanlıurfa" | "Şırnak" | "Tekirdağ" | "Tokat" | "Trabzon" | "Tunceli" | "Uşak" | "Van" | "Yalova" | "Yozgat" | "Zonguldak" ) []
+Defined in src/index.ts:105
@@ -30,7 +30,7 @@
Returns {
[ index : string ]: string []
+
Defined in src/index.ts:133
@@ -22,7 +22,7 @@
Function getDistrictsAndNeighbourhoodsOfEachCity
Returns CityCodeDistrictNeighbourhoodsMap
+Defined in src/index.ts:137
@@ -27,7 +27,7 @@
Parameters
code : "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67"
Returns string []
+Defined in src/index.ts:125
@@ -22,7 +22,7 @@
Function getDistrictsOfEachCity
Returns CityCodeDistrictMap
+Defined in src/index.ts:129
@@ -29,7 +29,7 @@
code : district : string
Returns string []
+Defined in src/index.ts:141
@@ -22,7 +22,7 @@
Function getPostalCodes
Returns string []
+Defined in src/index.ts:117
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is any []
+Defined in src/index.ts:15
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is City
+Defined in src/index.ts:68
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67"
+Defined in src/index.ts:27
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns boolean
+Defined in src/index.ts:31
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is "Adana" | "Adıyaman" | "Afyonkarahisar" | "Ağrı" | "Aksaray" | "Amasya" | "Ankara" | "Antalya" | "Ardahan" | "Artvin" | "Aydın" | "Balıkesir" | "Bartın" | "Batman" | "Bayburt" | "Bilecik" | "Bingöl" | "Bitlis" | "Bolu" | "Burdur" | "Bursa" | "Çanakkale" | "Çankırı" | "Çorum" | "Denizli" | "Diyarbakır" | "Düzce" | "Edirne" | "Elazığ" | "Erzincan" | "Erzurum" | "Eskişehir" | "Gaziantep" | "Giresun" | "Gümüşhane" | "Hakkari" | "Hatay" | "Iğdır" | "Isparta" | "İstanbul" | "İzmir" | "Kahramanmaraş" | "Karabük" | "Karaman" | "Kars" | "Kastamonu" | "Kayseri" | "Kırıkkale" | "Kırklareli" | "Kırşehir" | "Kilis" | "Kocaeli" | "Konya" | "Kütahya" | "Malatya" | "Manisa" | "Mardin" | "Mersin" | "Muğla" | "Muş" | "Nevşehir" | "Niğde" | "Ordu" | "Osmaniye" | "Rize" | "Sakarya" | "Samsun" | "Siirt" | "Sinop" | "Sivas" | "Şanlıurfa" | "Şırnak" | "Tekirdağ" | "Tokat" | "Trabzon" | "Tunceli" | "Uşak" | "Van" | "Yalova" | "Yozgat" | "Zonguldak"
+Defined in src/index.ts:56
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns boolean
+Defined in src/index.ts:60
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is object
+Defined in src/index.ts:11
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is string
+Defined in src/index.ts:121
@@ -27,7 +27,7 @@
Parameters
v : unknown
+Defined in types/index.d.ts:17
@@ -27,7 +27,7 @@
Parameters
v : unknown
+Defined in types/index.d.ts:20
Returns { code : CityCode ; distance : number ; } []
+Defined in types/index.d.ts:24
Returns number | undefined
+Defined in types/index.d.ts:23
@@ -22,7 +22,7 @@
Function getCities
+Defined in types/index.d.ts:27
@@ -22,7 +22,7 @@
Function getCityCodes
+Defined in types/index.d.ts:26
@@ -22,7 +22,7 @@
Function getCityNames
+Defined in types/index.d.ts:25
@@ -27,7 +27,7 @@
Parameters
city : "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67"
Returns string []
+Defined in types/index.d.ts:31
@@ -22,7 +22,7 @@
Function getDistrictsAndNeighbourhoodsOfEachCity
+Defined in types/index.d.ts:32
@@ -27,7 +27,7 @@
Parameters
city : "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67"
Returns string []
+Defined in types/index.d.ts:29
@@ -22,7 +22,7 @@
Function getDistrictsOfEachCity
+Defined in types/index.d.ts:30
@@ -29,7 +29,7 @@
code : district : string
Returns string []
+Defined in types/index.d.ts:33
@@ -22,7 +22,7 @@
Function getPostalCodes
+Defined in types/index.d.ts:28
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is City
+Defined in types/index.d.ts:21
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is "01" | "02" | "03" | "04" | "68" | "05" | "06" | "07" | "75" | "08" | "09" | "10" | "74" | "72" | "69" | "11" | "12" | "13" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "81" | "22" | "23" | "24" | "25" | "26" | "27" | "28" | "29" | "30" | "31" | "76" | "32" | "34" | "35" | "46" | "78" | "70" | "36" | "37" | "38" | "71" | "39" | "40" | "79" | "41" | "42" | "43" | "44" | "45" | "47" | "33" | "48" | "49" | "50" | "51" | "52" | "80" | "53" | "54" | "55" | "56" | "57" | "58" | "63" | "73" | "59" | "60" | "61" | "62" | "64" | "65" | "77" | "66" | "67"
+Defined in types/index.d.ts:15
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns boolean
+Defined in types/index.d.ts:16
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is "Adana" | "Adıyaman" | "Afyonkarahisar" | "Ağrı" | "Aksaray" | "Amasya" | "Ankara" | "Antalya" | "Ardahan" | "Artvin" | "Aydın" | "Balıkesir" | "Bartın" | "Batman" | "Bayburt" | "Bilecik" | "Bingöl" | "Bitlis" | "Bolu" | "Burdur" | "Bursa" | "Çanakkale" | "Çankırı" | "Çorum" | "Denizli" | "Diyarbakır" | "Düzce" | "Edirne" | "Elazığ" | "Erzincan" | "Erzurum" | "Eskişehir" | "Gaziantep" | "Giresun" | "Gümüşhane" | "Hakkari" | "Hatay" | "Iğdır" | "Isparta" | "İstanbul" | "İzmir" | "Kahramanmaraş" | "Karabük" | "Karaman" | "Kars" | "Kastamonu" | "Kayseri" | "Kırıkkale" | "Kırklareli" | "Kırşehir" | "Kilis" | "Kocaeli" | "Konya" | "Kütahya" | "Malatya" | "Manisa" | "Mardin" | "Mersin" | "Muğla" | "Muş" | "Nevşehir" | "Niğde" | "Ordu" | "Osmaniye" | "Rize" | "Sakarya" | "Samsun" | "Siirt" | "Sinop" | "Sivas" | "Şanlıurfa" | "Şırnak" | "Tekirdağ" | "Tokat" | "Trabzon" | "Tunceli" | "Uşak" | "Van" | "Yalova" | "Yozgat" | "Zonguldak"
+Defined in types/index.d.ts:18
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns boolean
+Defined in types/index.d.ts:19
@@ -27,7 +27,7 @@
Parameters
v : unknown
Returns v is string
+Defined in types/index.d.ts:22
-
turkey-neighbourhoods - v3.0.8
+
turkey-neighbourhoods - v3.0.12
Always up to date names of cities, districts and neighbourhoods of Turkey, available as JSON and JS. Refer to https://muratgozel.github.io/turkey-neighbourhoods/ for full api documentation.
**In Turkish: **
JSON ve JS formatında, her zaman güncel, Türkiye şehir, posta kodu, plaka kodu, ilçe ve mahalle listesi.
@@ -25,11 +25,12 @@
turkey-neighbourhoods - v3.0.8
Copy
Have a look at the tests, types and source for more info.
Data updates published regularly as minor
releases so you only need to update the package as new version comes in. If you have a kind of manual setup, you can run npm run setup
, compile
, build
and test
to fetch the new data. The module is smart enough to detect if the existing data is fresh or not.
+
If you're interested in contributing, read the CONTRIBUTING.md first, please.
Version management of this repository done by releaser 🚀
Thanks for watching 🐬
-
+
+Keeping Data Up To Date
+Contributing
diff --git a/docs/modules/src.html b/docs/modules/src.html
index 0a22cc1..142572d 100644
--- a/docs/modules/src.html
+++ b/docs/modules/src.html
@@ -1,4 +1,4 @@
-src | turkey-neighbourhoods - v3.0.8
+src | turkey-neighbourhoods - v3.0.12
@@ -16,7 +16,7 @@
src
Module src
+
Defined in src/index.ts:1
Index
@@ -59,7 +59,7 @@ Member Visibility
@@ -16,7 +16,7 @@
types
Module types
+
Defined in types/index.d.ts:1
Index
@@ -71,7 +71,7 @@ Member Visibility
@@ -18,7 +18,7 @@
Type alias City
+Defined in types/index.d.ts:13
@@ -18,7 +18,7 @@
Type alias CityCode
City Code : CityCode
+Defined in types/index.d.ts:2
@@ -18,7 +18,7 @@
Type alias CityCodeDistrictMap
City Code District Map : CityCodeDistrictMap
+Defined in types/index.d.ts:6
@@ -18,7 +18,7 @@
Type alias CityCodeDistrictNeighbourhoodsMap
City Code District Neighbourhoods Map : CityCodeDistrictNeighbourhoodsMap
+Defined in types/index.d.ts:7
@@ -18,7 +18,7 @@
Type alias CityCodeNameMap
City Code Name Map : CityCodeNameMap
+Defined in types/index.d.ts:5
@@ -18,7 +18,7 @@
Type alias CityListItem
City List Item : CityListItem
+Defined in types/index.d.ts:4
@@ -18,7 +18,7 @@
Type alias CityName
City Name : CityName
+Defined in types/index.d.ts:3
@@ -18,7 +18,7 @@
Type alias DistanceChild
Distance Child : DistanceChild
+Defined in types/index.d.ts:9
@@ -18,7 +18,7 @@
Type alias Distances
Distances : Distances
+Defined in types/index.d.ts:10
@@ -18,7 +18,7 @@
Type alias NeighbourhoodList
+Defined in types/index.d.ts:11
@@ -18,7 +18,7 @@
Type alias PostalCode
Postal Code : string
+Defined in types/index.d.ts:8