mockaroni

Type aliases

ArrayElementsType

ArrayElementsType<T>: T extends ArrayLike<infer ArrayElementsType> ? ArrayElementsType : never

Type parameters

T: ArrayLike<unknown>

DateConfig

DateConfig: { max: Date; min: Date }

Type declaration

max: Date

End point of date
min: Date

Start point of date

ListOfConfig

ListOfConfig<T>: { list: ArrayLike<T>; size: number }

Type parameters

Type declaration

list: ArrayLike<T>

List of values which resulting array will contain
size: number

The size of resulting array

ListOfReturnValue

ListOfReturnValue<T>: ArrayElementsType<ArrayLike<T>>[]

Type parameters

MockaroniConfig

MockaroniConfig: { random: any }

Type declaration

random:function
- random(): number
- - Defined in globalConfig.ts:5
  Randomization function
  
  Returns number

Nullable

Nullable<T, N>: T & { nullable?: N }

Type parameters

T: Record<any, any>
N: boolean = true

NumConfig

NumConfig: { max: number; min: number; type?: "float" | "int" }

Type declaration

max: number

High border of numbers
min: number

Low border of numbers
Optional type?: "float" | "int"

Would a result number be an integer or float

Default: 'int'

OneOfConfig

OneOfConfig<T>: { list: ArrayLike<T> }

Type parameters

Type declaration

list: ArrayLike<T>

List of values

OneOfReturnValue

OneOfReturnValue<T>: ArrayElementsType<ArrayLike<T>>

Type parameters

PartialWordsSet

PartialWordsSet: { names?: { female?: string[]; male?: string[]; mixed?: string[] }; words?: string[] }

Type declaration

Optional names?: { female?: string[]; male?: string[]; mixed?: string[] }
- Optional female?: string[]
- Optional male?: string[]
- Optional mixed?: string[]
Optional words?: string[]

RangeConfig

RangeConfig: { from: number; to: number }

Type declaration

from: number

Start point of numbers in the range
to: number

End point of numbers in the range

ReplicateConfig

ReplicateConfig<R>: { size: number; schema: any }

Type parameters

Type declaration

size: number

The size of resulting array
schema:function
- schema(index: number): R
- - Defined in lists/replicate.ts:12
  Map function
  
  Parameters
  - index: number
  Returns R

StringConfig

StringConfig: { format?: "capitalized" | "lowercase" | "uppercase" | "mixed"; locale?: "cyrillic" | "latin"; size: number; type?: "alpha" | "numeric" | "alphanumeric" }

Type declaration

Optional format?: "capitalized" | "lowercase" | "uppercase" | "mixed"

Case of string

Default: 'lowercase'
Optional locale?: "cyrillic" | "latin"

Alphabet of a string

Default: 'latin'
size: number

The size of resulting string Required
Optional type?: "alpha" | "numeric" | "alphanumeric"

Which characters would be in a string

Default: 'alpha'

TextConfig

TextConfig: { capitalized?: boolean; namesGender?: "male" | "female" | "mixed"; randomStringConfig?: StringConfig; size: number; type?: "words" | "random_string" | "names"; wordsSet?: PartialWordsSet }

Type declaration

Optional capitalized?: boolean

Should the text be capitalized (first letter is in upper case)

Default: false
Optional namesGender?: "male" | "female" | "mixed"

Genders of names if the type is 'names'

Default: 'mixed'
Optional randomStringConfig?: StringConfig

Config of random string if the type is 'random_string'

Default: { size: 7 }
size: number

Count of words in resulting text
Optional type?: "words" | "random_string" | "names"

The content of resulting text, would it be a random strings, names or plain words

Default: 'words'
Optional wordsSet?: PartialWordsSet

Custom list of words and names

Default: {}

Variables

Const wordsSet

wordsSet: { names: { female: string[]; male: string[]; mixed: string[] }; words: string[] } = ...

Type declaration

names: { female: string[]; male: string[]; mixed: string[] }
- female: string[]
- male: string[]
- mixed: string[]
words: string[]

Functions

assignSoft

assignSoft<T, U>(target: T, source: U): T & U
assignSoft<T, U, V>(target: T, source1: U, source2: V): T & U & V
assignSoft<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W
assignSoft(target: Record<any, any>, sources: Record<any, any>[]): Record<any, any>

- Defined in utils.ts:8
Analog of Object.assign. Will write only those values from the source, which is not represented in target Also working for nested object (expect arrays)

Type parameters
- T
- U
Parameters
- target: T
- source: U
Returns T & U
- Defined in utils.ts:9
Analog of Object.assign. Will write only those values from the source, which is not represented in target Also working for nested object (expect arrays)

Type parameters
- T
- U
- V
Parameters
- target: T
- source1: U
- source2: V
Returns T & U & V
- Defined in utils.ts:10
Analog of Object.assign. Will write only those values from the source, which is not represented in target Also working for nested object (expect arrays)

Type parameters
- T
- U
- V
- W
Parameters
- target: T
- source1: U
- source2: V
- source3: W
Returns T & U & V & W
- Defined in utils.ts:11
Analog of Object.assign. Will write only those values from the source, which is not represented in target Also working for nested object (expect arrays)

Parameters
- target: Record<any, any>
- sources: Record<any, any>[]
Returns Record<any, any>

capitalize

capitalize(str: string): string

- Defined in utils.ts:40
Parameters
- str: string
Returns string

date

date(config: DateConfig): Date
date(config: Nullable<DateConfig, false>): Date
date(config: Nullable<DateConfig, true>): Date | null

- Defined in primitives/date.ts:16
Generates a random date

Parameters
- config: DateConfig
Returns Date
- Defined in primitives/date.ts:17
Generates a random date

Parameters
- config: Nullable<DateConfig, false>
Returns Date
- Defined in primitives/date.ts:18
Generates a random date

Parameters
- config: Nullable<DateConfig, true>
Returns Date | null

listOf

listOf<T>(config: ListOfConfig<T>): ListOfReturnValue<T>
listOf<T>(config: Nullable<ListOfConfig<T>, false>): ListOfReturnValue<T>
listOf<T>(config: Nullable<ListOfConfig<T>, true>): ListOfReturnValue<T> | null

- Defined in lists/listOf.ts:18
Generates an array of provided values from list param

Type parameters
- T
Parameters
- config: ListOfConfig<T>
Returns ListOfReturnValue<T>
- Defined in lists/listOf.ts:19
Generates an array of provided values from list param

Type parameters
- T
Parameters
- config: Nullable<ListOfConfig<T>, false>
Returns ListOfReturnValue<T>
- Defined in lists/listOf.ts:20
Generates an array of provided values from list param

Type parameters
- T
Parameters
- config: Nullable<ListOfConfig<T>, true>
Returns ListOfReturnValue<T> | null

nullable

nullable<T>(obj: T): obj is Nullable<T, true>

- Defined in utils.ts:2
Type parameters
- T
Parameters
- obj: T
Returns obj is Nullable<T, true>

num

num(config: NumConfig): number
num(config: Nullable<NumConfig, false>): number
num(config: Nullable<NumConfig, true>): number | null

- Defined in primitives/num.ts:23
Generates a random number

Parameters
- config: NumConfig
Returns number
- Defined in primitives/num.ts:24
Generates a random number

Parameters
- config: Nullable<NumConfig, false>
Returns number
- Defined in primitives/num.ts:25
Generates a random number

Parameters
- config: Nullable<NumConfig, true>
Returns number | null

oneOf

oneOf<T>(config: OneOfConfig<T>): OneOfReturnValue<T>
oneOf<T>(config: Nullable<OneOfConfig<T>, false>): OneOfReturnValue<T>
oneOf<T>(config: Nullable<OneOfConfig<T>, true>): OneOfReturnValue<T> | null

- Defined in primitives/oneOf.ts:13
Providing a value from the list

Type parameters
- T
Parameters
- config: OneOfConfig<T>
Returns OneOfReturnValue<T>
- Defined in primitives/oneOf.ts:14
Providing a value from the list

Type parameters
- T
Parameters
- config: Nullable<OneOfConfig<T>, false>
Returns OneOfReturnValue<T>
- Defined in primitives/oneOf.ts:15
Providing a value from the list

Type parameters
- T
Parameters
- config: Nullable<OneOfConfig<T>, true>
Returns OneOfReturnValue<T> | null

range

range(listOf: number): number[]
range(listOf: RangeConfig): number[]
range(config: Nullable<RangeConfig, true>): number[] | null

- Defined in lists/range.ts:16
Generates a range of integers

Parameters
- listOf: number
Returns number[]
- Defined in lists/range.ts:17
Generates a range of integers

Parameters
- listOf: RangeConfig
Returns number[]
- Defined in lists/range.ts:18
Generates a range of integers

Parameters
- config: Nullable<RangeConfig, true>
Returns number[] | null

replicate

replicate<R>(config: ReplicateConfig<R>): R[]
replicate<R>(config: Nullable<ReplicateConfig<R>, false>): R[]
replicate<R>(config: Nullable<ReplicateConfig<R>, true>): R[] | null

- Defined in lists/replicate.ts:14
Generates an array of values from schema (like a second parameter of Array.from)

Type parameters
- R
Parameters
- config: ReplicateConfig<R>
Returns R[]
- Defined in lists/replicate.ts:15
Generates an array of values from schema (like a second parameter of Array.from)

Type parameters
- R
Parameters
- config: Nullable<ReplicateConfig<R>, false>
Returns R[]
- Defined in lists/replicate.ts:16
Generates an array of values from schema (like a second parameter of Array.from)

Type parameters
- R
Parameters
- config: Nullable<ReplicateConfig<R>, true>
Returns R[] | null

setConfig

setConfig(nextConfig: MockaroniConfig): void

- Defined in globalConfig.ts:11
Parameters
- nextConfig: MockaroniConfig
Returns void

str

str(config: StringConfig): string
str(config: Nullable<StringConfig, false>): string
str(config: Nullable<StringConfig, true>): string | null

- Defined in primitives/str.ts:65
Generates a random string

Parameters
- config: StringConfig
Returns string
- Defined in primitives/str.ts:66
Generates a random string

Parameters
- config: Nullable<StringConfig, false>
Returns string
- Defined in primitives/str.ts:67
Generates a random string

Parameters
- config: Nullable<StringConfig, true>
Returns string | null

text

text(config: TextConfig): string
text(config: Nullable<TextConfig, false>): string
text(config: Nullable<TextConfig, true>): string | null

- Defined in primitives/text.ts:71
Generates a random text separated by spaces

Parameters
- config: TextConfig
Returns string
- Defined in primitives/text.ts:72
Generates a random text separated by spaces

Parameters
- config: Nullable<TextConfig, false>
Returns string
- Defined in primitives/text.ts:73
Generates a random text separated by spaces

Parameters
- config: Nullable<TextConfig, true>
Returns string | null

trueOrFalse

trueOrFalse(): boolean

- Defined in primitives/boolean.ts:6
Returns true or false

Returns boolean

Index

Type aliases

Variables

Functions

Type aliases

ArrayElementsType

Type parameters

T: ArrayLike<unknown>

DateConfig

Type declaration

max: Date

min: Date

ListOfConfig

Type parameters

T

Type declaration

list: ArrayLike<T>

size: number

ListOfReturnValue

Type parameters

T

MockaroniConfig

Type declaration

random:function

Returns number

Nullable

Type parameters

T: Record<any, any>

N: boolean = true

NumConfig

Type declaration

max: number

min: number

Optional type?: "float" | "int"

OneOfConfig

Type parameters

T

Type declaration

list: ArrayLike<T>

OneOfReturnValue

Type parameters

T

PartialWordsSet

Type declaration

Optional names?: { female?: string[]; male?: string[]; mixed?: string[] }

Optional female?: string[]

Optional male?: string[]

Optional mixed?: string[]

Optional words?: string[]

RangeConfig

Type declaration

from: number

to: number

ReplicateConfig

Type parameters

R

Type declaration

size: number

schema:function

Parameters

index: number

Returns R

StringConfig

Type declaration

Optional format?: "capitalized" | "lowercase" | "uppercase" | "mixed"

Optional locale?: "cyrillic" | "latin"

size: number

Optional type?: "alpha" | "numeric" | "alphanumeric"

TextConfig

Type declaration

Optional capitalized?: boolean

Optional namesGender?: "male" | "female" | "mixed"

Optional randomStringConfig?: StringConfig

size: number

Optional type?: "words" | "random_string" | "names"

Optional wordsSet?: PartialWordsSet

Variables

Const wordsSet

Type declaration

names: { female: string[]; male: string[]; mixed: string[] }