truncate

truncate(code, to): Postcode

Shortens a postcode to a less precise segment, for example from a building to its area.

Parameters

code

Postcode

A parsed postcode.

to

Precision

The precision to keep. It must not be more precise than the code.

Returns

Postcode

The shorter postcode.

Throws

RangeError when to is more precise than the code, or is not a precision.

Example

const building = parse('EK-01-A03-FK-01');
if (building.ok) {
  truncate(building.value, 'district').canonical; // 'EK-01-A03'
}