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

fixed-width-ts-decorator

v1.2.0

Published

Fixed width file handler with TypeScript Decorator

Downloads

44

Readme

Fixed width file processing/parsing with TS Decorators

This lib provide decorator for fixed width file so that the domain class and spec can stay together. No separate schema creation is needed so that it is more readable, maintainable and extensible.

Usage

npm i fixed-width-ts-decorator

Example

This lib uses reflect-metadata for Meta programming.

Inheritance is supported that fields decorated in parent classes will also be included/processed.

Model definition

// class inheritance is Optional here.
export class Transaction extends FixedWidthConvertible {
  @FixedWidth({ start: 0, width: 5 })
  clientId: string;

  @FixedWidth({ start: 5, width: 40 })
  parentName: string;

  @FixedWidth({ start: 45, width: 40, format: { type: DataType.Float } })
  taxAmount: number;

  @FixedWidth({
    start: 85,
    width: 40,
    format: {
      type: DataType.Float,
      precision: 3,
    },
  })
  paymentAmount: number;

  @FixedWidth({
    start: 125,
    width: 20,
    format: { type: DataType.Integer },
  })
  paymentTimeStamp: number;

  @FixedWidth({ start: 145, width: 40 })
  userId: string;

  @FixedWidth({ start: 225, width: 40 })
  paymentId: string;
  // other non-decorated fields
  otherField: string;
}

Parse the file to Objects

(() => {
	// Or you can read file line by line
  const file = fs.readFileSync('data/sample.txt', { encoding: 'utf8' });
  const lines = file.split('\n').filter(l => l);
  const rs: Array<Transaction> = lines.map(line => {
    const trans = new Transaction();
		/**
	   * Option 1: if your domain class extends the abstract `FixedWidthConvertible` class,
		 * then you can use the instance.convertFixedWidth method.
		 */
    trans.convertFixedWidth(line);
		/**
		 * Option 2: if your domain class already extends some other classes
		 * then use the static function on the `FixedWidthConvertible` class and pass in the instance as argument like below.
     */
		// FixedWidthConvertible.convertFixedWidth(line, trans);
    return trans;
  });

  console.log(rs);
})()

Format Options

  • support parse to Integer or Float(with precision) other than the default String type.