subdivisionsToStateDefinitions
subdivisionsToStateDefinitions(
subdivisions,options?):StateDefinition[]
Defined in: packages/simply-settings-core/src/address/isoCodes/index.ts:40
Turns a source’s subdivisions into state definitions.
Parameters
Section titled “Parameters”subdivisions
Section titled “subdivisions”From a source.
options?
Section titled “options?”allLevels keeps subdivisions nested under another one (French departments
under their regions); by default only the top level is kept.
allLevels?
Section titled “allLevels?”boolean
Returns
Section titled “Returns”The definitions, in the source’s order.
Throws
Section titled “Throws”SfError (InvalidStateDefinitionsError) for an entry parseStateDefinitions rejects.