Civic Address Format

Formats a civic address from its pieces based on guidelines from Canada Post for properly addressing mail to Canadian and American addresses.

Includes Canadian postal code validation and formattings functions.

Features

• Typescript support.
• Places the unit number (when present) before the civic number with a hyphen in between.
• Uses no space when a single letter qualifier is present (i.e. '123A'), or one space for longer qualifiers (i.e. '123 1/2')

Installation

npm install @cityssm/civic-address-format

Usage

import formatCivicAddress, {
  formatPostalCode
} from '@cityssm/civic-address-format'

formatCivicAddress({
  civicNumber: '99',
  streetName: 'Foster Dr'
})
// => "99 Foster Dr"

formatCivicAddress({
  civicNumber: '123',
  streetName: 'MAIN ST NW',
  unitNumber: '10',
  qualifier: '1/2'
})
// => "10-123 1/2 MAIN ST NW"

formatPostalCode('p6a5x6')
// => "P6A 5X6"

Related NPM Packages

Statistics Canada (StatsCan) Tools for Node Lookups and utilities for working with Statistics Canada (StatsCan) data.

MPAC Tools for Node Lookups and utilities for working with MPAC data.