@verisure-italy/zipcode-types
v1.7.13
Published
Types for ZipCode service
Downloads
283
Readme
@verisure-italy/zipcode-types
Domain contracts for geographic areas and enabled ZIP codes.
Installation
pnpm add @verisure-italy/zipcode-typesMain Exports
enabledSchemaandtype EnabledareaSchemaandtype Area
What This Package Gives You
- a lightweight ZIP-enablement contract
- an area model for geographic datasets and ZIP-to-location mappings
Schema Inventory
| Schema | Type alias | Kind | Purpose |
| --- | --- | --- | --- |
| enabledSchema | Enabled | object schema | Enabled ZIP-code entry |
| areaSchema | Area | object schema | Area mapping |
Schema Reference
enabledSchema
| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| zipCode | ZipCode | Yes | Five-digit ZIP code |
areaSchema
| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| id | string | Yes | UUID |
| city | string | Yes | Minimum 2 characters |
| province | string | Yes | Min 2, max 3 characters |
| region | string | Yes | Minimum 2 characters |
| town | string | Yes | Minimum 2 characters |
| zipCode | ZipCode | Yes | Five-digit ZIP code |
Example
import { areaSchema } from '@verisure-italy/zipcode-types'
const area = areaSchema.parse({
id: '550e8400-e29b-41d4-a716-446655440000',
city: 'Milan',
province: 'MI',
region: 'Lombardy',
town: 'Milan',
zipCode: '20100',
})