API Reference: SpoofSettings

The settings object accepted as the first argument of create and createWith. Every field is optional; omitted fields fall back to the defaults shown below.

export class SpoofSettings {
  dateMax?: Date;
  dateMin?: Date;
  numberMin?: number;
  numberMax?: number;
  numberFloat?: boolean;
  stringNumbers?: boolean;
  stringLowCase?: boolean;
  stringUpCase?: boolean;
  stringSpecial?: boolean;
  stringLength?: number;
  arrayLength?: number;
}

Number options

Field	Type	Default	Description
`numberMin`	`number`	`1`	Inclusive lower bound for generated numbers
`numberMax`	`number`	`1000`	Inclusive upper bound; auto-fixed to `numberMin + 100` when smaller than `numberMin`
`numberFloat`	`boolean`	`false`	`true` produces fractional numbers instead of integers

Details and examples: Number settings.

String options

Field	Type	Default	Description
`stringNumbers`	`boolean`	`true`	Include digits `0-9` in the charset
`stringLowCase`	`boolean`	`true`	Include lowercase letters in the charset
`stringUpCase`	`boolean`	`true`	Include uppercase letters in the charset
`stringSpecial`	`boolean`	`true`	Include special characters in the charset
`stringLength`	`number`	`10`	Exact length of generated strings

Details and examples: String settings.

Date options

Field	Type	Default	Description
`dateMin`	`Date` or `string`	`new Date(2000, 0, 1)`	Inclusive lower bound; strings are parsed to dates
`dateMax`	`Date` or `string`	`new Date(4000, 0, 1)`	Inclusive upper bound; auto-fixed to `dateMin + 24h` when earlier than `dateMin`

Details and examples: Date settings.

Array options

Field	Type	Default	Description
`arrayLength`	`number`	`3`	Exact length of every generated array, at any depth

Details and examples: Array settings.

Merging behavior

Passed settings are merged over a fresh SpoofSettings instance per call — a partial object never disables defaults for the fields it omits:

Forger.create<number>({ numberMax: 10 });
// numberMin stays at its default 1

08 September 2026