README
BreakpointDataHandler
@jogitt
last updated: 2021-12-01
This package houses functions for reading, writing, and memory storing breakpoint data.
Usage
- you first need to set a BreakpointDataHandlerGlobals object:
import {BreakpointDataHandlerGlobalsBuilder} from 'breakpointdatahandler';
const projectGlobals = new BreakpointDataHandlerGlobalsBuilder().setType(FileType.DEPARTMENT).setInPath(process.env.DEPT_DATA_CSV as string).setOutPath("out").build();
- then, set if you want DepartmentFileHandler, VendorFileHandler, or ProductFileHandler:
import {DepartmentFileHandler} from 'breakpointdatahandler';
const deptFileHandler = new DepartmentFileHandler(projectGlobals);
- to read breakpoint data to memory:
import {IDepartment} from 'breakpointdatahandler';
const response:IDepartment[] = await deptFileHandler.read();
- to write data to disc:
const response = await deptFileHandler.write(data, outPath)
- for products, you can also read json format into memory
const productJsonFileHandler = new ProductFileHandler(testGlobals);
const response: IProduct[] = await productJsonFileHandler.readJsonFile();
- update 0.9.0, can do readJson for vendor or departments now as well:
const departmentFileHandler = new DepartmentFileHandler(testGlobals);
const response: IDepartment[] = await departmentFileHandler.readJsonFile();