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

tassign

v1.0.0

Published

Fixed-arity, subset-typed, non-mutating Object.assign.

Downloads

17,811

Readme

tassign

This is a simple wrapper for fixed-arity, subset-typed, non-mutating Object.assign.

Why?

This came about when writing Redux reducers in TypeScript. Since reducers must not mutate the passed in state, a common pattern is to 'set' store properties using Object.assign():

interface IMyState {
  foo: Number;
}

function myReducer(state: IMyState, action: Action) {
  switch(action.type) {
    case SET_FOO_ACTION: 
      return Object.assign({}, state, { foo: 3 });
  }
  
  return state;
}

This works well enough. Object.assign to an empty object produces a new object with the new value of foo. However I wasn't happy with it from a type-enforcement perspective.

The reason is that for a reducer use case, I would like to enforce that the reducer can only set known properties of IMyState.

Using the regular, intersection-based Object.assign typings, this is perfectly legal:

interface IMyState {
  foo: Number;
}

function myReducer(state: IMyState, action: Action) {
  switch(action.type) {
    case SET_FOO_ACTION: 
      // No TS error - I would like there to be.
      return Object.assign({}, state, { foo: 3, bar: 'wat' });
  }
  
  return state;
}

Formally, Object.assign(t:T, u:U) returns a type which is the intersection of T & U, meaning that properties can be added onto the assignee. This is reasonable in the general case for Object.assign, but it's not what I want in a reducer.

In a reducer, I want assign(t:T, u:U) to enforce a subset rule: the return value should be an instance of T, and only subsets of T's type are legal values for U. In short I want to make sure you can only assign members of U to the object returned by the reducer.

So, here's a utility that handles the typings the way I want in a reducer:

interface IMyState {
  foo: Number;
}

function myReducer(state: IMyState, action: Action) {
  switch(action.type) {
    case SET_FOO_ACTION: 
      // Returns a new object with the type of the first argument.
      // Type of the second argument must be a subset of the type of the first argument.
      
      // Fails: bar is not a member of IMyState.
      return tassign(state, { foo: 3, bar: 'wat' });
  }
  
  return state;
}