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

typesafe-cli

v1.0.8

Published

A simple CLI tool to allow writing Python-like type annotations to JS.

Downloads

19

Readme

Version Install size Minzipped size Downloads/month

TypeSafe

TypeSafe is (technically) a 'language' created solely to bring Python-like type hints to JavaScript, at runtime. This 'compiler' simply takes your TypeSafe code and converts it to valid JavaScript code with proper runtime type checking.

How does it work?

Syntax

The syntax is stolen from Python's type hints and TypeScript. The main difference between TypeSafe and TypeScript being simply when and how the type checking occurs: in TypeSafe, valid vanilla JavaScript type checking is injected into your code, replacing the type hints.

TypeSafe uses colons followed by a type name to allow type checking. Type hints can be placed after any variable or parameter name, and after a function declaration. All built-in types are supported and classes can also be used as types.

// variable declarations
const str: string = "Hello, world!";
let num: number = 123;

// using a class as a type
class Foo {
	constructor(bar) {
		this.bar = bar;
	}
}

var foo: Foo = new Foo("bar");

// functions
// function name(param1: type, ...): return type {}
function multiply(x: number, y: number): number {
	return x * y;
}

Completeness

This project is a work-in-progress, it is not yet even near close to completion.

Current capabilities

  • Variable declarations: The compiler can currently add proper type checking for single variable declarations (will not work when multiple variables are declared using commas, also will not work for more complex assignments such as multiline functions, chained expressions, etc). This solely means checking that a variable is the correct type after it is declared. In future this will likely aim to check type on every assignment operation (although this will dramatically increase bloat...).
  • Basic functions: The compiler can currently add proper type checking for a basic function declaration, including parameters and a return type. This does not include lambda (or squid) functions.

Work-in-progress

  • Arrays: The compiler should be able to perform type checking for arrays, allowing statically typed arrays.

Future capabilities

  • For loops: The compiler should be able to perform type checking for variables declared inside of any for loop.

Pros and Cons

Why should you use TypeSafe?

This project is for fun, in reality there is likely little to no real reason to ever use TypeSafe for your own projects, if you think of one, let me know!

  • Runtime type checking: TypeSafe will enable you to get proper runtime errors for invalid types. In theory though, if you use TypeScript or something similar, these issues should never arise in the first place, avoiding the bloat that TypeSafe would introduce.

Why shouldn't you use TypeSafe?

  • File sizes: TypeSafe will increase your file sizes; the more code you write, the more significantly your file size will increase.