address

faker. address

Source:

address.js, line 1

Methods

(static) cardinalDirection(useAbbr)

cardinal direction

Source:

address.js, line 291

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) cardinalDirection(useAbbr)

cardinal direction

Source:

address.js, line 291

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) city(format)

Generates a random localized city name. The format string can contain any method provided by faker wrapped in {{}}, e.g. {{name.firstName}} in order to build the city name.

If no format string is provided one of the following is randomly used:

{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}
{{address.cityPrefix}} {{name.firstName}}
{{name.firstName}}{{address.citySuffix}}
{{name.lastName}}{{address.citySuffix}}

Source:

address.js, line 47

Parameters:

Name	Type	Description
`format`	`String`

(static) city(format)

Generates a random localized city name. The format string can contain any method provided by faker wrapped in {{}}, e.g. {{name.firstName}} in order to build the city name.

If no format string is provided one of the following is randomly used:

{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}
{{address.cityPrefix}} {{name.firstName}}
{{name.firstName}}{{address.citySuffix}}
{{name.lastName}}{{address.citySuffix}}

Source:

address.js, line 47

Parameters:

Name	Type	Description
`format`	`String`

(static) cityPrefix()

Return a random localized city prefix

Source:

address.js, line 78

(static) cityPrefix()

Return a random localized city prefix

Source:

address.js, line 78

(static) citySuffix()

Return a random localized city suffix

Source:

address.js, line 86

(static) citySuffix()

Return a random localized city suffix

Source:

address.js, line 86

(static) country()

country

Source:

address.js, line 185

(static) country()

country

Source:

address.js, line 185

(static) countryCode(alphaCode)

countryCode

Source:

address.js, line 194

Parameters:

Name	Type	Description
`alphaCode`	`string`	default alpha-2

(static) countryCode(alphaCode)

countryCode

Source:

address.js, line 194

Parameters:

Name	Type	Description
`alphaCode`	`string`	default alpha-2

(static) county()

county

Source:

address.js, line 176

(static) county()

county

Source:

address.js, line 176

(static) direction(useAbbr)

direction

Source:

address.js, line 273

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) direction(useAbbr)

direction

Source:

address.js, line 273

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) latitude(max, min, precision)

latitude

Source:

address.js, line 233

Parameters:

Name	Type	Description
`max`	`Double`	default is 90
`min`	`Double`	default is -90
`precision`	`number`	default is 4

(static) latitude(max, min, precision)

latitude

Source:

address.js, line 233

Parameters:

Name	Type	Description
`max`	`Double`	default is 90
`min`	`Double`	default is -90
`precision`	`number`	default is 4

(static) longitude(max, min, precision)

longitude

Source:

address.js, line 253

Parameters:

Name	Type	Description
`max`	`Double`	default is 180
`min`	`Double`	default is -180
`precision`	`number`	default is 4

(static) longitude(max, min, precision)

longitude

Source:

address.js, line 253

Parameters:

Name	Type	Description
`max`	`Double`	default is 180
`min`	`Double`	default is -180
`precision`	`number`	default is 4

(static) ordinalDirection(useAbbr)

ordinal direction

Source:

address.js, line 313

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) ordinalDirection(useAbbr)

ordinal direction

Source:

address.js, line 313

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) secondaryAddress()

secondaryAddress

Source:

address.js, line 162

(static) secondaryAddress()

secondaryAddress

Source:

address.js, line 162

(static) state(useAbbr)

state

Source:

address.js, line 214

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`

(static) state(useAbbr)

state

Source:

address.js, line 214

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`

(static) stateAbbr()

stateAbbr

Source:

address.js, line 224

(static) stateAbbr()

stateAbbr

Source:

address.js, line 224

(static) streetAddress(useFullAddress)

Returns a random localized street address

Source:

address.js, line 121

Parameters:

Name	Type	Description
`useFullAddress`	`Boolean`

(static) streetAddress(useFullAddress)

Returns a random localized street address

Source:

address.js, line 121

Parameters:

Name	Type	Description
`useFullAddress`	`Boolean`

(static) streetName()

Returns a random localized street name

Source:

address.js, line 95

(static) streetName()

Returns a random localized street name

Source:

address.js, line 95

(static) streetPrefix()

streetPrefix

Source:

address.js, line 153

(static) streetPrefix()

streetPrefix

Source:

address.js, line 153

(static) streetSuffix()

streetSuffix

Source:

address.js, line 144

(static) streetSuffix()

streetSuffix

Source:

address.js, line 144

(static) timeZone()

Return a random time zone

Source:

address.js, line 387

(static) timeZone()

Return a random time zone

Source:

address.js, line 387

(static) zipCode(format)

Generates random zipcode from format. If format is not specified, the locale's zip format is used.

Source:

address.js, line 9

Parameters:

Name	Type	Description
`format`	`String`

(static) zipCode(format)

Generates random zipcode from format. If format is not specified, the locale's zip format is used.

Source:

address.js, line 9

Parameters:

Name	Type	Description
`format`	`String`

(static) zipCodeByState(state)

Generates random zipcode from state abbreviation. If state abbreviation is not specified, a random zip code is generated according to the locale's zip format. Only works for locales with postcode_by_state definition. If a locale does not have a postcode_by_state definition, a random zip code is generated according to the locale's zip format.

Source:

address.js, line 29

Parameters:

Name	Type	Description
`state`	`String`

(static) zipCodeByState(state)

Source:

address.js, line 29

Parameters:

Name	Type	Description
`state`	`String`

faker. address

Source:

address.js, line 1

Methods

(static) cardinalDirection(useAbbr)

cardinal direction

Source:

address.js, line 291

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) cardinalDirection(useAbbr)

cardinal direction

Source:

address.js, line 291

Parameters:

Name	Type	Description
`useAbbr`	`Boolean`	return direction abbreviation. defaults to false

(static) city(format)

Generates a random localized city name. The format string can contain any method provided by faker wrapped in {{}}, e.g. {{name.firstName}} in order to build the city name.

If no format string is provided one of the following is randomly used:

{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}
{{address.cityPrefix}} {{name.firstName}}
{{name.firstName}}{{address.citySuffix}}
{{name.lastName}}{{address.citySuffix}}

Source:

address.js, line 47

Parameters:

Name	Type	Description
`format`	`String`

(static) city(format)

Generates a random localized city name. The format string can contain any method provided by faker wrapped in {{}}, e.g. {{name.firstName}} in order to build the city name.

If no format string is provided one of the following is randomly used: