Reference · Framing, geometry and quiz tools
portNamefunction
A place's name in a language: Japanese on a Japanese page where it has one, else English.
Import it
import { portName } from "@johnmorrisdotca/chizu";
Definition
function portName(port: Pick<ChizuPort, "name">, language: ChizuLanguage): string
Parameters
| Name | Type | Description |
|---|---|---|
port | Pick<ChizuPort, "name"> | The place. |
language | ChizuLanguage |
|
Returns
string
Its name.
Examples
import { portName, type ChizuPort } from "@johnmorrisdotca/chizu";
const port: ChizuPort = { id: "yokohama", kind: "harbour", name: { en: "Yokohama", ja: "横浜港" }, country: "JP", lat: 35.45, lon: 139.65, tier: 1 };
console.log(portName(port, "en"), portName(port, "ja"));
// Yokohama 横浜港Yokohama 横浜港What it prints (run when this page was built)