@antv/data-wizard
Version:
A js/ts library for data processing
55 lines (54 loc) • 1.24 kB
TypeScript
import { TextRandom } from './text-random';
import { WebDB, TextDB } from './database';
/**
* Generator for web
* @public
*/
export declare class WebRandom extends TextRandom {
database: WebDB & TextDB;
/**
* Return a random top-level domain ({@link https://en.wikipedia.org/wiki/Top-level_domain | TLD})
* @remarks return one of database.tlds
*/
tld(): string;
/**
* Return a random domain
* @param options - the params
*/
domain(options?: DomainOptions): string;
/**
* Return a random url
* @param options - the params
*/
url(options?: UrlOptions): string;
/**
* Return a random ip v4
*/
ipv4(): string;
/**
* Return a random ip v6
*/
ipv6(): string;
/**
* Return a random email
* @param options - the params
*/
email(options?: EmailOptions): string;
}
/** @public */
export interface DomainOptions {
tld?: string;
}
/** @public */
export interface UrlOptions extends DomainOptions {
protocol?: string;
domain?: string;
domainPrefix?: string;
path?: string;
extensions?: string[];
}
/** @public */
export interface EmailOptions {
domain?: string;
length?: number;
}