UNPKG

t-comm

Version:

专业、稳定、纯粹的工具库

699 lines (698 loc) 16.2 kB
import { ProvType } from './types'; /** * 获取如下格式的城市列表,包含`全国`、`全省`选项 * @returns {Array} 城市列表 * @example * * 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', * // }, * // // ... * // ], * // }, * // // ... * // ]; * */ export declare function getAreaDataAll(): ProvType[]; /** * 获取城市列表,默认不包含`全省`选项 * @param {object} [data] 原始数据 * @param {array} [areaArray = []] 结果列表 * @param {boolean} [allProvFlag = false] 是否包含`全省`选项 * @returns {Array} 城市列表 * @example * * 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', * // }, * // // ... * // ], * // }, * // // ... * // ]; * */ export declare function getAreaData(data?: { provData: { 11: string; 12: string; 13: string; 14: string; 15: string; 21: string; /** * 获取如下格式的城市列表,包含`全国`、`全省`选项 * @returns {Array} 城市列表 * @example * * 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', * // }, * // // ... * // ], * // }, * // // ... * // ]; * */ 22: string; 23: string; 31: string; 32: string; 33: string; 34: string; 35: string; 36: string; 37: string; 41: string; 42: string; 43: string; 44: string; 45: string; 46: string; 50: string; 51: string; 52: string; 53: string; 54: string; 61: string; 62: string; 63: string; 64: string; 65: string; 71: string; 81: string; 82: string; }; cityData: { 11: string[]; 12: string[]; 13: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; }; 14: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; }; 15: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 22: string; 25: string; 29: string; 30: string; }; 21: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; 14: string; }; 22: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 24: string; 25: string; }; 23: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 27: string; }; 31: string[]; 32: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; }; 33: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; }; 34: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 10: string; 11: string; 12: string; 13: string; 14: string; 15: string; 16: string; 17: string; 18: string; }; 35: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; }; 36: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; }; 37: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; 14: string; 15: string; 16: string; 17: string; }; 41: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; 14: string; 15: string; 16: string; 17: string; 18: string; 19: string; }; 42: { 1: string; 2: string; 3: string; 5: string; /** * 根据省份城市转化为`id`数组 * @param {string} provinceStr * @param {string} cityStr * @returns {Array} 包含省份、城市ID的数组 * * @example * const res = getAreaCode('山东', '德州'); * // ['37', '14'] */ 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; 28: string; 94: string; 95: string; 96: string; A21: string; }; 43: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; 31: string; }; 44: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 12: string; 13: string; 14: string; 15: string; 16: string; 17: string; 18: string; 19: string; 20: string; 51: string; 52: string; 53: string; }; 45: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 13: string; 14: string; }; 46: { 1: string; 2: string; 91: string; 92: string; 93: string; 95: string; 96: string; 97: string; A25: string; A26: string; A27: string; A28: string; A30: string; A31: string; A33: string; A34: string; A35: string; A36: string; A37: string; A38: string; A39: string; }; 50: string[]; 51: { 1: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 13: string; 14: string; 15: string; 16: string; 17: string; 18: string; 19: string; 20: string; 32: string; 33: string; 34: string; }; 52: { 1: string; 2: string; 3: string; 4: string; 22: string; /** * 根据`id`获取省份名字 * @param {string | number} provinceId * @returns {string} 省份名字 * * @example * const res = getProvName(37) * // 山东 * * const res2 = getCityName(11) * // 北京 */ 23: string; 24: string; 26: string; 27: string; 31: string; 32: string; 33: string; 34: string; 35: string; 36: string; 37: string; }; 53: { 1: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 23: string; 25: string; 26: string; 28: string; 29: string; 31: string; 33: string; 34: string; }; 54: { 1: string; 21: string; 22: string; 23: string; 24: string; 25: string; 26: string; }; 61: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; }; 62: { 1: string; 2: string; 3: string; 4: string; 5: string; 6: string; 7: string; 8: string; 9: string; 10: string; 11: string; 12: string; 29: string; 30: string; }; 63: { 1: string; 21: string; 22: string; 23: string; 25: string; 26: string; 27: string; 28: string; }; 64: { 1: string; 2: string; 3: string; 4: string; 5: string; }; 65: { 1: string; 2: string; 21: string; 22: string; 23: string; 27: string; 28: string; 29: string; 30: string; 31: string; 32: string; 40: string; 42: string; 43: string; 91: string; 92: string; 93: string; 94: string; }; 71: string[]; 81: string[]; 82: string[]; }; }, areaArray?: Array<ProvType>, allProvFlag?: boolean): ProvType[]; /** * 根据省份城市转化为`id`数组 * @param {string} provinceStr * @param {string} cityStr * @returns {Array} 包含省份、城市ID的数组 * * @example * const res = getAreaCode('山东', '德州'); * // ['37', '14'] */ export declare function getAreaCode(provinceStr?: string, cityStr?: string): any; /** * 根据`id`将省份城市转化为字符串数组 * @param {string | number} provinceId * @param {string | number} cityId * @returns {Array} 包含省份、城市名字的数组 * * @example * const res = getProvName(37, 14) * // ['山东', '德州'] * * const res2 = getCityName(11) * // ['北京', '北京'] */ export declare function getAreaName(provinceId: string | number, cityId?: number): string[]; /** * 根据`id`获取省份名字 * @param {string | number} provinceId * @returns {string} 省份名字 * * @example * const res = getProvName(37) * // 山东 * * const res2 = getCityName(11) * // 北京 */ export declare function getProvName(provinceId: string | number): string; /** * 根据`id`获取城市名字 * @param {string | number} provinceId * @param {string | number} cityId * @returns {string} 城市名字 * * @example * const res = getCityName(37, 14) * // 德州 * * const res2 = getCityName(11) * // 北京 */ export declare function getCityName(provinceId: number | string, cityId?: number | string): string;