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

mithril-proptypes

v3.2.1

Published

Tiny efficient type-checking library for use with Mithril.js with syntax similar to React.PropTypes.

Downloads

8

Readme

npm npm

mithril-proptypes

Awesome lightweight library for data validation and type checking for Mithril.js inspired by React PropTypes. You can you this library as a standalone dependency, because it doesn't have a binding with Mithril.js, though provides special tools to easy integration with Mitril.

const propTypes = { id: PropTypes.number.isRequired, name: PropTypes.string, done: PropTypes.boolean, };

const props = { id: 1, name: 'Dmitry Salnikov', done: 'false' };

checkProps(props)(propTypes);

// WARN >> PropTypes warning: Wrong prop type for "done": "string" instead of declared "boolean"


<h2>With ES6 classes</h2>
If you use es6 classes for mithril components, then you can do the check in the constructor for example:
```js
import { PropTypes, checkProps } from 'mithril-proptypes';

const propTypes = {
  id: PropTypes.number.isRequired,
  name: PropTypes.string,
  done: PropTypes.boolean,
};

class TodoItem {
  constructor(props) {
    checkProps(props)(propTypes);
    
    this.props = props;
  }
  
  view() {
    return (
      <div className="TodoItem">{this.props.name}</div>
    );
  }
}

const propTypes = { id: PropTypes.number.isRequired, name: PropTypes.string, done: PropTypes.boolean, };

class TodoItem extends MithrilComponent { constructor(props) { super(props, propTypes);

this.props = props;

}

view() { return ( {this.props.name} ); } }

Now this check is doing by MithrilComponent.

<h2>Additional features of MithrilComponent</h2>
MithrilComponent class also adds useful lifecycle method onUnload() to your component.
This method will be called by mithril.js when this component is going to be removed from the DOM, so you can save some data for example. 
```js
import { MithrilComponent, PropTypes } from 'mithril-proptypes';

class App extends MithrilComponent {
  constructor(props) {
    super();
    
    this.props = props;
  }
  
  onUnload() {
    console.log('Component is going to be removed from the DOM');
  }
  
  view() {
    return <div className="App"></div>;
  }
}

var propTypes = { someObject: PropTypes.objectWith({ first: PropTypes.number, second: PropTypes.string, third: PropTypes.boolean, }), someArray: PropTypes.arrayOf({ id: PropTypes.number, gender: PropTypes.string, married: PropTypes.boolean, }).isRequired, };


<h2>Required Props</h2>
Is some property is 'required' by the data doesn't contain this property - then check will print error.
To mark some prop as required you can add '.isRequired' to each prop type:
```js
var props = {};

var propTypes = {
    someProp: PropTypes.number.isRequired,
};

checkProps(props)(propTypes);
// ERROR >> PropTypes warning: data for the required prop someProp is absent!

At first - download and install Node.js if you need. It contains own package-manager - NPM. Then run npm to install all necessary dependencies

npm install mithril-proptypes --save

// ...

checkProps(props)(proptypes);


<h2>Panned Features</h2>
* Turn off checks for production