teainahat / chain-able

Easy interfaces that describe their intentions

⛓ chain-able

interfaces that describe their intentions

🗣 expressive

traditional

class Traditional {
  constructor() {
    this.data = {}
  }
  build(index, name, object) {
    this.data.index = index
    this.data.name = name
    this.data.object = object
  }
}
const classico = new Traditional()
classico.build(1, 'string', {object: true})

fluent

class Chain extends Chainable {
  constructor(parent) {
    super(parent)
    this.extend(['index', 'name', 'object'])
  }
}
const chain = new Chainable()
  .index(1)
  .name('string')
  .object(true)

🏰 benefits

writing an api using chain-able means:

• write 1 api,
• get 3 apis as a result!
  • 🍉 persistable, rehydratable, & transferrable configurations
  • ⛓ fluent/chainable api
  • 🍦 vanilla object syntax

🎁 features

• ▶️◀️ easy deep merging
• 🌐 api
  • 🍭 iteratable
  • 🗣 expressive
  • 💆 seamless native integration
• 🤖 transformable
  • 🕵 debuggable
  • 👣 traversable
  • 🗺 remappable
  • 👆 tap
• 🎼 composable
  • 👂 observable
  • 🛂 types & validation
  • 🔌 extend
    • alias
    • increment
    • true/false
  • dot-prop
  • shorthand
    • .chainWrap
    • .bindMethods
    • .setIfEmpty
  • define
    • extendGetSet
    • defineGetSet
  • ❄️ immutable
• 🏭 nestable factories
• ⚡ performant & tiny ~7kb (gzip) 300 byte minimal version available as snippet

🔗 links & more

• 😎⛓ awesome fluents
• many thanks to Eli Perelman for all the chainable goodness
• thanks to James Halliday for the tremendous traversals
• thanks to Sindre Sorhus for the simple dot-prop access
• thanks to Josh Duff for deep merging
• based on webpack-chain, but not webpack-specific.
• transpiled with buble
• Martin Fowler on FluentInterface