Localization

The following generator functions are available in the Localization provider:

┌────────────────────┬───────────────────┬────────────────┐
│ Generator Function │ Available Locales │ Unique Entries │
│             String │             Int64 │          Int64 │
├────────────────────┼───────────────────┼────────────────┤
│ address_complement │                 2 │              3 │
│     address_format │                 2 │              5 │
│               city │                 8 │            750 │
│            country │                 3 │            729 │
│           district │                 2 │            104 │
│             locale │                 1 │              2 │
│           postcode │                 2 │              2 │
│              state │                14 │            420 │
│      street_format │                 2 │              5 │
│      street_prefix │                 2 │             12 │
│      street_suffix │                 2 │              5 │
└────────────────────┴───────────────────┴────────────────┘

The localization generator functions follow the standards defined by ISO 3166 in order to organize the entries and returned values. When appropriate, each docstring will point out the ISO 3166 variant being returned.

Impostor.address — Function

address(n::Integer = 1; kws...)
address(options::Vector{<:AbstractString}, n::Integer = 1; level::Symbol, kws...)
address(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Generate n or length(mask) addresses based on options or mask according to the required level. For example, let level = :country_code and options be the required country codes to generate addresses for, e.g. ["BRA", "USA"], the expected output will contain only addresses (in their specific formats) for location in Brazil ("BRA") and the United States ("USA"). Other values may be passed as level.

Parameters

n::Integer = 1: number of addresses to generate.
options::Vector{<:AbstractString}: vector with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :state_code: option level to be used when using option and mask-based generation.

source

Impostor.address_complement — Function

address_complement(n::Integer = 1; kws...)

Parameters

n::Integer = 1: number of address complements to generate.

Kwargs

locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.city — Function

city(n::Integer = 1; kws...)
city(options::Vector{<:AbstractString}, n::Integer; level, kws...)
city(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Parameters

n::Integer = 1: number of country codes to generate.
options::Vector{<:AbstractString}: vector with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :state_code: Level of values in options or mask when using option-based or mask-based eneration.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.country — Function

country(n::Integer = 1; kws...)
country(options::Vector{<:AbstractString}, n::Integer; level::Symbol, kws...)
country(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Generate n or length(mask) country names.

Parameters

n::Integer = 1: number of country name entries to generate.
options::Vector{<:AbstractString}: vector with with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :country_code: Level of values in options or mask when using option-based or mask-based generation.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.country_code — Function

country_code(n::Integer = 1; kws...)
country_code(options::Vector{<:AbstractString}, n::Integer; level::Symbol, kws...)
country_code(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Generate n or length(mask) country codes.

Parameters

n::Integer = 1: number of country codes to generate.
options::Vector{<:AbstractString}: vector with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :country_code: Level of values in options or mask when using option-based or mask-based eneration.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.country_official_name — Function

country_official_name(n::Integer = 1; kws...)
country_official_name(options::Vector{<:AbstractString}, n::Integer; level::Symbol, kws...)
country_official_name(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Generate n or length(mask) country official names.

Parameters

n::Integer = 1: number of country official names entries to generate.
options::Vector{<:AbstractString}: vector with with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :country_code: Level of values in options or mask when using option-based or mask-based generation.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.district — Function

district(n::Integer = 1; kws...)
district(options::Vector{<:AbstractString}, n::Integer; level::Symbol, kws...)
district(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Parameters

n::Integer = 1: number of district names to generate.
options::Vector{<:AbstractString}: vector with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :district_name: Level of values in options or mask when using option-based or mask-based eneration.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.postcode — Function

postcode(n::Integer = 1; kws...)

Parameters

n::Integer = 1: number of postcodes to generate.

Kwargs

locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.state — Function

state(n::Integer = 1; kws...)
state(options::Vector{<:AbstractString}, n::Integer; level::Symbol, kws...)
state(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Parameters

n::Integer = 1: number of country codes to generate.
options::Vector{<:AbstractString}: vector with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :country_code: Level of values in options or mask when using option-based or mask-based eneration.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.state_code — Function

state_code(n::Integer = 1; kws...)
state_code(options::Vector{<:AbstractString}, n::Integer; level::Symbol, kws...)
state_code(mask::Vector{<:AbstractString}; level::Symbol, kws...)

Parameters

n::Integer = 1: number of state codes to generate.
options::Vector{<:AbstractString}: vector with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

Kwargs

level::Symbol = :country_code: Level of values in options or mask when using option-based or mask-based eneration.
locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.street — Function

street(n::Integer = 1; kws...)
street(options::Vector{<:AbstractString}, n::Integer; kws...)
street(mask::Vector{<:AbstractString}; kws...)

Generate n street names. Note that for option and mask-based generation the only valid options to provide are country_codes.

Parameters

n::Integer = 1: number of street names entries to generate.
options::Vector{<:AbstractString}: vector with with options restricting the possible values generated.
mask::Vector{<:AbstractString}: mask vector with element-wise option restrictions.

source

Impostor.street_number — Function

street_number(n::Integer = 1)

Parameters

n::Integer = 1: number of street numbers to generate.

source

Impostor.street_prefix — Function

street_prefix(n::Integer = 1; kws...)

Kwargs

locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source

Impostor.street_suffix — Function

street_suffix(n::Integer = 1; kws...)

Kwargs

locale::Vector{String}: locale(s) from which entries are sampled. If no locale is provided, the current session locale is used.

source