@noeldemartin/faker
Version:
Generate massive amounts of fake contextual data
54 lines (53 loc) • 1.18 kB
TypeScript
import type { Faker } from '../..';
/**
* Module to generate database related entries.
*/
export declare class DatabaseModule {
private readonly faker;
constructor(faker: Faker);
/**
* Returns a random database column name.
*
* @example
* faker.database.column() // 'createdAt'
*
* @since 4.0.0
*/
column(): string;
/**
* Returns a random database column type.
*
* @example
* faker.database.type() // 'timestamp'
*
* @since 4.0.0
*/
type(): string;
/**
* Returns a random database collation.
*
* @example
* faker.database.collation() // 'utf8_unicode_ci'
*
* @since 4.0.0
*/
collation(): string;
/**
* Returns a random database engine.
*
* @example
* faker.database.engine() // 'ARCHIVE'
*
* @since 4.0.0
*/
engine(): string;
/**
* Returns a MongoDB [ObjectId](https://docs.mongodb.com/manual/reference/method/ObjectId/) string.
*
* @example
* faker.database.mongodbObjectId() // 'e175cac316a79afdd0ad3afb'
*
* @since 6.2.0
*/
mongodbObjectId(): string;
}