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

@forked-soft/avro-to-typescript

v1.5.4

Published

Package for converting Avro schema files (.avsc) to TypeScript class files

Downloads

33

Readme

avro-to-typescript

npm version build status

Forked from @chasdevs/avro-to-typescript

avro-to-typescript compiles avro schema files (.avsc) to TypeScript classes and interfaces. Making using avro schematics with node.js easy and comfortable.

This fork removes the schema registry and node-rdkafka dependencies for a lighter-weight install.

Features

  • Compiles most if not all avro types (record, enum, primitive, map, array)

Usage

Global:

Most projects will use avro-to-typescript this way

npm install -g @forked-soft/avro-to-typescript

avro-to-typescript --compile [ schema-directory ] [ output-directory ]

This will generate namespaced folders and files for your schemas inside output directory so have that in mind.

You also need to install avro-to-typescript in your project.

npm install @forked-soft/avro-to-typescript --save

Project:

This way is if your projects needs to generate avro classes while running.

npm install @forked-soft/avro-to-typescript --save
import { Compiler } from "forked-soft/avro-to-typescript";

const compiler = new Compiler(outputDir);
await compiler.compile(avro);

Logical Types:

If you want to take advantage of logical types, you can pass these as an argument to the cli

avro-to-typescript --compile [ schema-directory ] [ output-directory ] --logical-types [avro type] [typescript type]

You can even pass more than one if you alternate them:

avro-to-typescript --compile [ schema-directory ] [ output-directory ] --logical-types [avro type] [typescript type] [avro type] [typescript type]

You can also pass them to the compiler in your code directly:

import { Compiler } from "forked-soft/avro-to-typescript";

const compiler = new Compiler(outputDir, { date: 'string', 'timestamp-millis': 'string'} });
await compiler.compile(avro);

If there are logical types in the avro schema but you don't provide a mapping for them, they will default to the underlying primitive type.

Contribution and Support

If you are having issues, please let us know on our issue tracker.

  • Issue Tracker: github.com/forked-soft/avro-to-typescript/issues
  • Source Code: github.com/forked-soft/avro-to-typescript

License

The project is licensed under the MIT license.