⛓ chain-able

interfaces that describe their intentions

❗ chain-able now has a website! 🔗 chain-able.js.org

📦 install

yarn add chain-able
npm i chain-able --save

cdn

• dev <script src="https://unpkg.com/chain-able@beta/dists/dev/index.js"></script>
• min <script src="https://unpkg.com/chain-able@beta/dists/umd/index.js"></script>

🏰 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

• expressive, clearly communicative code
• runtime type validation
• 🔬 300+ tests with 96%+ code coverage
• ⚡ performant & tiny ~8kb (gzip) 300 byte minimal version available as snippet

• 🌐 api
  • ⛓ Chainable
  • 🗺 ChainedMap
  • 🔢 ChainedSet
  • 🍴 extends Map & Set, same transparent api
  • 🔣 symbols to make usage even easier
• 🍭 iteratable
• 🗣 expressive
• 👾 makes solving complex problems simple
• 💆 seamless native integration
• 🎼 compose & decorate
  • 👂 observe with Wildcard/Glob, RegExp, Functions
  • 🤖 transform
  • 🕵 debug
  • 👣 traverse any data
  • ⚖️ fast deepEquals
  • 🗺 remap
  • 👆 tap
  • 🔋 toggleable dot.prop
  • 🖐 shorthands, wrap, return, setIfEmpty
• 🛂 types, schemas, validation
• 🔌 method builder
  • onCall
  • onSet
  • onGet
  • type
  • define
  • getSet
  • default
  • initial
  • bind
  • camelCase
  • autoIncrement
  • factory
  • returns
  • callReturns
  • decorate (any object!)
• 🏭 infinitely nestable understandable factories
• ▶️◀️ easy deep merging
• ☮️ compatibility - typescript, nodejs, webpack, rollup, fusebox, babel, buble, amd

🔗 related

• 😎⛓ 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.
• thanks to Jon Schlinkert & inferno for type checking inspirations
• transpiled with buble
• Martin Fowler on FluentInterface
• ramda & lodash for some well tested & documented utilities (currying, mapping)