Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 2.3 KB

README.md

File metadata and controls

54 lines (38 loc) · 2.3 KB

MPAC Year-End Tax File (YETF) Parser

npm (scoped) Codacy Badge Maintainability codecov GitHub Workflow Status

This project is not endorsed by the Municipal Property Assessment Corporation (MPAC).

This project takes an MPAC YETF and parses it into usable objects.

Features

  • Fully typed results with TypeScript.
  • Returns all of the data as strings, but can optionally parse the data into numbers.
  • Optionally defines the codes used. (i.e. Structure Code '760' corresponds to 'Police Station')
  • Makes all of the parsers, lookups, and helper functions available for reuse.

Installation

npm install @cityssm/mpac-yetf

Usage

import { parseYetf } from '@cityssm/mpac-yetf'

await parseYetf('yetf2022.txt', {
  addFormattedFields: true,
  callbacks: {
    all: (record, lineNumber) => {
      console.log(record)
    },
    AA: (record) => {
      // Save Property Creation record to database
    }
  }
})

I Just Want the Data in a Format I Can Use

The City of Sault Ste. Marie uses this package in another project that converts the YETF into a SQLite database, compatible with reporting tools like Microsoft Excel, Microsoft Power BI, and Metabase.

See the mpac-yetf-to-sqlite project.

I Prefer to Use Java

The City of Sault Ste. Marie also offers a similar Java application to parse the MPAC YETF.

See the mpacParser project.