@veriterra/types

VeriTerra Types Library - TypeScript type definitions for VeriTerra applications.

Installation

npm install @veriterra/types

Description

This package provides TypeScript type definitions for VeriTerra applications, focusing on location and address data structures. It's designed to be used with TypeScript projects that integrate with VeriTerra services or Dynamics 365.

Usage

import { SearchAddress } from '@veriterra/types';

// Example usage
const address: SearchAddress = {
  buildingNumber: '123',
  buildingName: 'Tech Tower',
  roadName: 'Innovation Street',
  town: 'Tech City',
  postcode: 'TC1 2AB',
  wkt: 'POINT(0 0)',
  polygonRawData: '...',
  organisationName: 'VeriTerra Ltd',
  subBuildingName: 'Suite 4B',
  locality: 'Tech District'
};

Types

SearchAddress

Interface for address data with the following properties:

• buildingNumber: String representing the building number
• buildingName: String representing the building name
• roadName: String representing the road or street name
• town: String representing the town or city
• postcode: String representing the postal code
• wkt: String in Well-Known Text format for spatial data
• polygonRawData: String containing raw polygon data
• organisationName: String representing the organization name
• subBuildingName: String representing the sub-building name
• locality: String representing the locality

Keywords

• veriterra
• types
• typescript
• sdk
• dynamics365

License

ISC

Author

Veriand Consulting Ltd.