chertoperter
Version:
Fake data generator for Persian developers
43 lines • 1.72 kB
TypeScript
/**
* Returns the list of available provinces.
* @returns {string[]} An array of province names.
*/
declare const ProvinceGenerator: () => string[];
/**
* Returns a list of places, optionally including user-defined places.
* @param {Object} [config] - Optional configuration for custom places.
* @param {string[]} [config.place] - Additional custom places to include.
* @returns {string[]} An array of place names.
*/
declare const PlaceGenerator: (config?: {
place?: string[];
}) => string[];
/**
* Returns a list of alleys, optionally including user-defined alleys.
* @param {Object} [config] - Optional configuration for custom alleys.
* @param {string[]} [config.alley] - Additional custom alleys to include.
* @returns {string[]} An array of alley names.
*/
declare const AlleyGenerator: (config?: {
alley?: string[];
}) => string[];
/**
* Returns a list of squares, optionally including user-defined squares.
* @param {Object} [config] - Optional configuration for custom squares.
* @param {string[]} [config.square] - Additional custom squares to include.
* @returns {string[]} An array of square names.
*/
declare const SquareGenerator: (config?: {
square?: string[];
}) => string[];
/**
* Returns a list of streets, optionally including user-defined streets.
* @param {Object} [config] - Optional configuration for custom streets.
* @param {string[]} [config.street] - Additional custom streets to include.
* @returns {string[]} An array of street names.
*/
declare const StreetGenerator: (config?: {
street?: string[];
}) => string[];
export { ProvinceGenerator, AlleyGenerator, PlaceGenerator, SquareGenerator, StreetGenerator };
//# sourceMappingURL=index.d.ts.map