lcn/types/src/util.d.ts

中华人民共和国行政区划，省市区数据

/**
 * 获取省份编码。
 *
 * @param code 省市区编码。
 * @returns 如果值的长度是大于等于 2 ，返回前 2 位字符，否则返回空字符串。
 * @example
 * getProvinceCode('110102'); // '11'
 * getProvinceCode(); // ''
 */
export declare function getProvinceCode(code?: string): string;
/**
 * 获取省市编码。
 *
 * @param code 省市区编码。
 * @returns 如果值的长度是大于等于 4 ，返回前 4 位字符，否则返回空字符串。
 * @example
 * getCityCode('110102'); // '1101'
 * getCityCode(); // ''
 */
export declare function getCityCode(code?: string): string;
/**
 * 判断是否为省份编码。
 *
 * @param code 要检查的编码。
 * @returns 如果值的长度为 6，且后 4 位字符等于 `0000`，返回 `true`，否则返回 `false`。
 * @example
 * isProvinceCode('110000'); // true
 * isProvinceCode('110100'); // false
 * isProvinceCode('110102'); // false
 * isProvinceCode(); // false
 */
export declare function isProvinceCode(code?: string): boolean;
/**
 * 判断是否为市级编码。
 *
 * @param code 要检查的编码。
 * @returns 如果值的长度为 6 ，最后 2 位等于 `00`，且后4位字符不等于 `0000`，返回 `true`，否则返回 `false`。
 * @example
 * isCityCode('110000'); // false
 * isCityCode('110100'); // true
 * isCityCode('110102'); // false
 * isCityCode(); // false
 */
export declare function isCityCode(code?: string): boolean;
/**
 * 判断是否为区县编码。
 *
 * @param code 要检查的编码。
 * @returns 如果值的长度为 6 ，最后 2 位不等于 `00`，且后4位字符不等于 `0000`，返回 `true`，否则返回 `false`。
 * @example
 * isAreaCode('110000'); // false
 * isAreaCode('110100'); // false
 * isAreaCode('110102'); // true
 * isAreaCode(); // false
 */
export declare function isAreaCode(code?: string): boolean;
/**
 * 判断是否为内地省市区。
 *
 * @param code 要检查的编码。
 * @returns 如果是中国大陆内地省市区编码，返回 `true`，否则返回 `false`。
 * @example
 * isInland('110102'); // true
 *
 * // 71/81/82 开头的编码都返回 false
 * isInland('710000'); // false
 * isInland('810000'); // false
 * isInland('820000'); // false
 */
export declare const isInland: (code?: string) => boolean;
/**
 * 判断是否为直辖市或直辖县的市级。
 *
 * @param code 要检查的编码。
 * @returns 如果是直辖县的市级，返回 `true`，否则返回 `false`。
 * @example
 * isCrownCountryCityCode('110100'); // true
 * isCrownCountryCityCode('310100'); // true
 * isCrownCountryCityCode('500100'); // true
 * isCrownCountryCityCode('500200'); // true
 *
 * isCrownCountryCityCode('441300'); // fasle
 */
export declare const isCrownCountryCityCode: (code?: string) => boolean;