Frederik Krautwald Frikki

Simpler Variadic Function Types in TypeScript (part 1)

Variadic functions, such as the common zip function on arrays, are convenient and remove the need for lots of specific arity-function variants, e.g., zip2, zip3, zip4, etc. However, they can be difficult and tedious to type correctly in TypeScript when the return type depends on the parameter types, and the parameter types are heterogeneous.

Zip Example

Given a typical zip on arrays:

const a: number[] = [1, 2, 3]

NOTE: This guide is ONLY for devs who don't want to edit their yarn.lock file by hand. If you don't care about that please carry on.

So you've pulled the latest master

git checkout master
git pull

Functional TypeScript Naming Convention

Motivation

Giving names in a language that doesn't support function overloading is a challenging task. It is, however, important to follow some standards to avoid naming conflicts, misleading names, and also to maintain a unified style. The following rules were developed to encourage programming in a functional style in TypeScript, but can also be used anywhere else where it makes sense.

Disclaimer

The following rules are work in progress, and far from being complete, your questions and ideas are welcome. Please leave a comment.

Goals

Avoid naming conflicts and misleading names.

made with esnextbin

	Cato*
	Logged Out
	log in -> Logged In
	sign up -> User Registration

	Logged In
	log out -> Logged Out

	Onboarding*
	learn about Cato -> Documentation

	Cato*
	Logged Out
	log in -> Logged In
	sign up -> User Registration

	Logged In
	log out -> Logged Out
	onboard user -> Onboarding

	Onboarding*

	Cato*
	Logged Out*
	log in -> Logged In

	Logged In
	log out -> Logged Out

	Onboarding*
	learn about Cato -> Documentation

	/*
	* Copyright 2016, Matthieu Dumas
	* This work is licensed under the Creative Commons Attribution 4.0 International License.
	* To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/
	*/

	/* Usage :
	* var log = Logger.get("myModule") // .level(Logger.ALL) implicit
	* log.info("always a string as first argument", then, other, stuff)
	* log.level(Logger.WARN) // or ALL, DEBUG, INFO, WARN, ERROR, OFF

	{
	"lerna": "2.11.0",
	"version": "independent",
	"npmClient": "yarn",
	"useWorkspaces": true,
	"command": {
	"publish": {
	"allowBranch": "master"
	}
	}