Stampit

Create objects from reusable, composable behaviors

Stampit is a 1.4KB gzipped (or 3K minified) JavaScript module which supports three different kinds of prototypal inheritance (delegation, concatenation, and functional) to let you inherit behavior in a way that is much more powerful and flexible than any other Object Oriented Programming model.

Stamps are standardised composable factory functions. Stampit is a handy implementation of the specification featuring friendly API.

Find many more examples in this series of mini blog posts or on the official website.

Example

1import stampit from 'stampit'
2
3const Character = stampit({
4  props: {
5    name: null,
6    health: 100
7  },
8  init({ name = this.name }) {
9    this.name = name
10  }
11})
12
13const Fighter = Character.compose({ // inheriting
14  props: {
15    stamina: 100
16  },
17  init({ stamina = this.stamina }) {
18    this.stamina = stamina;    
19  },
20  methods: {
21    fight() {
22      console.log(`${this.name} takes a mighty swing!`)
23      this.stamina--
24    }
25  }
26})
27
28const Mage = Character.compose({ // inheriting
29  props: {
30    mana: 100
31  },
32  init({ mana = this.mana }) {
33    this.mana = mana;    
34  },
35  methods: {
36    cast() {
37      console.log(`${this.name} casts a fireball!`)
38      this.mana--
39    }
40  }
41})
42
43const Paladin = stampit(Mage, Fighter) // as simple as that!
44
45const fighter = Fighter({ name: 'Thumper' })
46fighter.fight()
47const mage = Mage({ name: 'Zapper' })
48mage.cast()
49const paladin = Paladin({ name: 'Roland', stamina: 50, mana: 50 })
50paladin.fight()
51paladin.cast()
52
53console.log(Paladin.compose.properties) // { name: null, health: 100, stamina: 100, mana: 100 }
54console.log(Paladin.compose.methods) // { fight: [Function: fight], cast: [Function: cast] }

Status

• v1. npm i stampit@1
• v2. npm i stampit@2 Breaking changes
• v3. npm i stampit@3 Breaking changes. Compatible with the stamp specification <= 1.4
• v4. npm i stampit Breaking changes. Compatible with the stamp specification v1.5
• next. npm i @stamp/it The new ecosystem of useful stamps like collision control, etc.

Install

Compatibility

Stampit should run fine in any ES5 browser or any node.js.

API

See https://stampit.js.org

What's the Point?

Prototypal OO is great, and JavaScript's capabilities give us some really powerful tools to explore it, but it could be easier to use.

Basic questions like "how do I inherit privileged methods and private data?" and "what are some good alternatives to inheritance hierarchies?" are stumpers for many JavaScript users.

Let's answer both of these questions at the same time.

1// Some privileged methods with some private data.
2const Availability = stampit({
3  init() {
4    let isOpen = false; // private
5
6    this.open = function open() {
7      isOpen = true;
8      return this;
9    };
10    this.close = function close() {
11      isOpen = false;
12      return this;
13    };
14    this.isOpen = function isOpenMethod() {
15      return isOpen;
16    }
17  }
18});
19
20// Here's a stamp with public methods, and some state:
21const Membership = stampit({
22  props: {
23    members: {}
24  },
25  methods: {
26    add(member) {
27      this.members[member.name] = member;
28      return this;
29    },
30    getMember(name) {
31      return this.members[name];
32    }
33  }
34});
35
36// Let's set some defaults:
37const Defaults = stampit({
38  props: {
39    name: "The Saloon",
40    specials: "Whisky, Gin, Tequila"
41  },
42  init({ name, specials }) {
43    this.name = name || this.name;
44    this.specials = specials || this.specials;
45  }
46});
47
48// Classical inheritance has nothing on this.
49// No parent/child coupling. No deep inheritance hierarchies.
50// Just good, clean code reusability.
51const Bar = stampit(Defaults, Availability, Membership);
52
53// Create an object instance
54const myBar = Bar({ name: "Moe's" });
55
56// Silly, but proves that everything is as it should be.
57myBar.add({ name: "Homer" }).open().getMember("Homer");

For more examples see the API or the Fun With Stamps mini-blog series.

Development

Unit tests

npm t

Unit and benchmark tests

env CI=1 npm t

Unit tests in a browser

To run unit tests in a default browser:

npm run browsertest

To run tests in a different browser:

• Open the ./test/index.html in your browser, and
• open developer's console. The logs should indicate success.

Publishing to NPM registry

1npx cut-release

It will run the cut-release utility which would ask you if you're publishing patch, minor, or major version. Then it will execute npm version, git push and npm publish with proper arguments for you.