Class SchemaImpl<T>

Type Parameters

T

Implements

Schema<T>

Index

Constructors

constructor

new SchemaImpl<T>(
generator: (context: GeneratorContext) => T,
initialOptions?: Record<string, any>,
): SchemaImpl<T>
Type Parameters
- T
Parameters
- generator: (context: GeneratorContext) => T
- initialOptions: Record<string, any> = {}
Returns SchemaImpl<T>
- Defined in schema.ts:36

Properties

`Protected`constraints

constraints: { predicate: (val: T) => boolean; retries: number }[] = []

`Protected` `Readonly`currentOptions

currentOptions: Record<string, any> = {}

`Protected` `Readonly`generatorFn

generatorFn: (context: GeneratorContext) => T

Methods

casing

casing(c: "lower" | "upper" | "capitalize" | "title"): this
Parameters
- c: "lower" | "upper" | "capitalize" | "title"
Returns this
- Defined in schema.ts:177

chars

chars(c: string): this
Parameters
- c: string
Returns this
- Defined in schema.ts:168

`Protected`cloneWithOptions

cloneWithOptions(newOptions: Partial<Record<string, any>>): this
Internal helper to create a new instance with updated options
Parameters
- newOptions: Partial<Record<string, any>>
Returns this
- Defined in schema.ts:228

distribution

distribution(
d: "uniform" | "normal" | "exponential" | "recent",
opts?: any,
): this
Parameters
- d: "uniform" | "normal" | "exponential" | "recent"
- Optionalopts: any
Returns this
- Defined in schema.ts:205

exclude

exclude(e: string | RegExp | (string | RegExp)[]): this
Parameters
- e: string | RegExp | (string | RegExp)[]
Returns this
- Defined in schema.ts:180

generate

generate(
    contextOptions?: Partial<Omit<GeneratorContext, "rng" | "options">> & {
        seed?: number;
    },
): T
Generates a single value using the schema.
Parameters
- contextOptions: Partial<Omit<GeneratorContext, "rng" | "options">> & { seed?: number } = {}
Returns T
Implementation of Schema.generate
- Defined in schema.ts:45

generateMany

generateMany(count: number, options?: { seed?: number }): T[]
Generates an array of values using the schema.
Parameters
- count: number
- options: { seed?: number } = {}
Returns T[]
Implementation of Schema.generateMany
- Defined in schema.ts:95

integer

integer(): this
Returns this
- Defined in schema.ts:193

length

length(l: number): this
Parameters
- l: number
Returns this
- Defined in schema.ts:165

likelihood

likelihood(p: number): this
Parameters
- p: number
Returns this
- Defined in schema.ts:223

max

max(v: string | number | Date): this
Parameters
- v: string | number | Date
Returns this
- Defined in schema.ts:190

maxLength

maxLength(l: number): this
Parameters
- l: number
Returns this
- Defined in schema.ts:162

min

min(v: string | number | Date): this
Parameters
- v: string | number | Date
Returns this
- Defined in schema.ts:187

minLength

minLength(l: number): this
Parameters
- l: number
Returns this
- Defined in schema.ts:159

negative

negative(): this
Returns this
- Defined in schema.ts:199

onlyBusinessHours

onlyBusinessHours(e?: boolean): this
Parameters
- e: boolean = true
Returns this
- Defined in schema.ts:212

onlyWeekdays

onlyWeekdays(e?: boolean): this
Parameters
- e: boolean = true
Returns this
- Defined in schema.ts:209

optional

optional(probability?: number): Schema<null | T>
Makes the generated value potentially null.
Parameters
- probability: number = 0.5
Returns Schema<null | T>
Implementation of Schema.optional
- Defined in schema.ts:122

pattern

pattern(p: RegExp): this
Parameters
- p: RegExp
Returns this
- Defined in schema.ts:183

pipe

pipe<U>(...tf: ((val: any, context: GeneratorContext) => any)[]): Schema<U>
Chains multiple transformation functions.
Type Parameters
- U
Parameters
- ...tf: ((val: any, context: GeneratorContext) => any)[]
Returns Schema<U>
Implementation of Schema.pipe
- Defined in schema.ts:146

positive

positive(): this
Returns this
- Defined in schema.ts:196

precision

precision(d: number): this
Parameters
- d: number
Returns this
- Defined in schema.ts:202

prefix

prefix(p: string): this
Parameters
- p: string
Returns this
- Defined in schema.ts:171

sort

sort(s?: boolean | ((a: any, b: any) => number)): this
Parameters
- Optionals: boolean | ((a: any, b: any) => number)
Returns this
- Defined in schema.ts:219

suffix

suffix(s: string): this
Parameters
- s: string
Returns this
- Defined in schema.ts:174

transform

transform<U>(fn: (val: T, context: GeneratorContext) => U): Schema<U>
Applies a transformation function after generation.
Type Parameters
- U
Parameters
- fn: (val: T, context: GeneratorContext) => U
Returns Schema<U>
Implementation of Schema.transform
- Defined in schema.ts:132

unique

unique(u?: boolean): this
Parameters
- u: boolean = true
Returns this
- Defined in schema.ts:216

where

where(predicate: (val: T) => boolean, retries?: number): Schema<T>
Adds a constraint that the generated value must satisfy. Retries generation up to retries times if the predicate fails.
Parameters
- predicate: (val: T) => boolean
- retries: number = 10
Returns Schema<T>
Implementation of Schema.where
- Defined in schema.ts:138