npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@teamhive/csv-processor

v2.0.0

Published

csv-processor simplifies reading and transforming CSV data into other formats through TypeDI services.

Downloads

3

Readme

@teamhive/csv-processor

csv-processor is a package that simplifies reading and transforming CSV data into other formats through TypeDI services. The typical usecase for the package would be converting a CSV file into individual SQL insert statements. This package handles all of the file I/O as well as recognizing line breaks within single or double quote

Usage

To install the package, run:

npm i @teamhive/csv-processor

The package itself defines two main export ProcessInput and ProcessOutput. Both classes are typedi services and should be constructed as typedi dependencies.

ProcessOuput

This service opens up a file to write to and line-by-line writes the input provided by the addLine(columns: string[], values: string[]) function. To open up the output file, call

processOutput.initialize(filePath: string, transform: TransformInput)

This will open the file and wait for calls to addLine().

Once all lines have been written to the output, close() should be called.

TransformOutput

TransformOuput is an interface for creating a transform that converts the input of addLine into a string that will be printed to the output file.

export interface TransformOutput {
    transformOutput(columns: string[], vals: string[]): string;
}

When using ProcessOutput, an implementation of TransformOutput must be passed to the initialize function. A transform is required for output since the arrays must be formatted as a string.

ProcessInput

ProcessInput is a TypeDi service that reads in a csv file and passses the read input to a ProcessOutput instance. TypeDi handles the injection of contructed ProcessOuput instance.

To use ProcessInput, simply call the processFile(filePath: string, transform?: TransformInput, useSingleQuotes: boolean) function on an instance of ProcessInput. For input, the transform is not necessary. If useSingleQuotes is true, new lines and commas within matched single quotes will not be used as delimeters. Otherwise, it uses double quotes as a delimeter.

TransformInput

TransformInput is an interface for creating a transform that converts the read input from the csv file before it is passed to addLine.

export interface TransformOutput {
    transformOutput(columns: string[], vals: string[]): string;
}

Example

export class AppService {

    constructor(
        private readonly errorHandler: ErrorHandler,
        private readonly processOutput: ProcessOutput,
        private readonly processInput: ProcessInput,
        private readonly transformInput: TransformAddDescriptionHtml,
        private readonly transformOuput: TransformWrapLink
    ) { }

    async run() {
        try {
            const startTime = Date.now();
            this.errorHandler.captureBreadcrumb({ message: 'Running TypeDi Seed...' });

            const inputPath = path.join(__dirname, '../../', config.get<string>('path.input'));
            const outputPath = path.join(__dirname, '../../', config.get<string>('path.output'));
            await this.processOutput.initialize(outputPath, this.transformOuput);
            await this.processInput.processFile(inputPath, this.transformInput);
            await this.processOutput.close();

            this.errorHandler.captureBreadcrumb({ message: `Finished TypeDi seeds in ${Date.now() - startTime} ms` });
            this.exit();
        }
        catch (error) {
            // await to guarantee the error gets captured before the process exits
            await this.errorHandler.captureException(error);
            this.exit();
        }
    }

    private exit(): void {
        // any preexit tasks

        process.exit();
    }
}

Distribution

npm pack
npm version (major|minor|patch)
npm publish

Note: This will also automatically push changes and tags post-publish