Swiss Mock names

Quickstart: JavaScript/TypeScript API

Install the module as follows:

npm i mock-ch-names
# or
yarn add mock-ch-names

Use as follows to get a mock person from anywhere in Switzerland:

import { mockNameLocation } from "mock-ch-names";

console.log(mockNameLocation());

Possible output:

{
  first: 'Martin',
  last: 'Meier',
  gender: 'm',
  plz: '7208',
  town: 'Malans GR',
  townNoCanton: 'Malans',
  canton: 'GR'
}

(If the town name in the postal database does not end in the canton's abbreviation, town and townNoCanton are identical.)

To only get mock people from a particular canton, pass the canton's two-letter abbreviation (e.g., SH) as an optional parameter to mockNameLocation().

Data sources

This database of mock Swiss names is based on the following data:

vornamen_proplz: CC-BY, Die Schweizerische Post (2022-07-01)
nachnamen_proplz: CC-BY, Die Schweizerische Post (2022-07-01)
plz_verzeichnis_v2: CC-BY, Die Schweizerische Post (2022-07-11)

Data format

Raw data

For description of the raw/ data, see the Swiss Post descriptions above.

Processed data

The data in src/data/ is JSON matching the following TypeScript types:

type NameMap = Record<
  string,
  {
    f: [Array1Plus<string>, Array1Plus<string>];
    m: [Array1Plus<string>, Array1Plus<string>];
    l: string;
    c: Canton;
  }
>;
type PlzMap = Record<string, [string, string]>;