引入

import {
  getAreaDataAll,
  getAreaData,
  getAreaCode,
  getAreaName,
  getProvName,
  getCityName
} from 't-comm';

// 不支持 tree-shaking 的项目
import {
  getAreaDataAll,
  getAreaData,
  getAreaCode,
  getAreaName,
  getProvName,
  getCityName
} from 't-comm/lib/city/index';

// 只支持 ESM 的项目
import {
  getAreaDataAll,
  getAreaData,
  getAreaCode,
  getAreaName,
  getProvName,
  getCityName
} from 't-comm/es/city/index';

getAreaDataAll()

描述：

获取如下格式的城市列表，包含全国、全省选项

参数：

返回: Array

城市列表

示例

const res = getAreaDataAll();
// [
//   {
//     text: '全国',
//     code: '0',
//     children: [{
//       text: '不限',
//       code: '0',
//     }],
//   },
//   {
//     text: '北京',
//     code: '11',
//     children: [{
//       text: '北京',
//       code: '0',
//     }],
//   },
//   {
//     text: '天津',
//     code: '12',
//     children: [{
//       text: '天津',
//       code: '0',
//     }],
//   },
//   {
//     text: '河北',
//     code: '13',
//     children: [{
//       text: '全省',
//       code: '0',
//     },
//     {
//       text: '石家庄',
//       code: '1',
//     },
//     {
//       text: '唐山',
//       code: '2',
//     },
//       // ...
//     ],
//   },
//   // ...
// ];

getAreaData([data], [areaArray], [allProvFlag])

描述：

获取城市列表，默认不包含全省选项

参数：

参数名	类型	默认值	描述
[data]	object		原始数据
[areaArray]	array	[]	结果列表
[allProvFlag]	boolean	false	是否包含全省选项

返回: Array

城市列表

示例

const res = getAreaData();
// [
//   {
//     text: '北京',
//     code: '11',
//     children: [{
//       text: '北京',
//       code: '0',
//     }],
//   },
//   {
//     text: '天津',
//     code: '12',
//     children: [{
//       text: '天津',
//       code: '0',
//     }],
//   },
//   {
//     text: '河北',
//     code: '13',
//     {
//       text: '石家庄',
//       code: '1',
//     },
//     {
//       text: '唐山',
//       code: '2',
//     },
//       // ...
//     ],
//   },
//   // ...
// ];

getAreaCode(provinceStr, cityStr)

描述：

根据省份城市转化为id数组

参数：

参数名	类型
provinceStr	string
cityStr	string

返回: Array

包含省份、城市ID的数组

示例

const res =  getAreaCode('山东', '德州');
// ['37', '14']

getAreaName(provinceId, cityId)

描述：

根据id将省份城市转化为字符串数组

参数：

参数名	类型
provinceId	string | number
cityId	string | number

返回: Array

包含省份、城市名字的数组

示例

const res =  getProvName(37, 14)
// ['山东', '德州']

const res2 =  getCityName(11)
// ['北京', '北京']

getProvName(provinceId)

描述：

根据id获取省份名字

参数：

参数名	类型
provinceId	string | number

返回: string

省份名字

示例

const res =  getProvName(37)
// 山东

const res2 =  getCityName(11)
// 北京

getCityName(provinceId, cityId)

描述：

根据id获取城市名字

参数：

参数名	类型
provinceId	string | number
cityId	string | number

返回: string

城市名字

示例

const res =  getCityName(37, 14)
// 德州

const res2 =  getCityName(11)
// 北京