UNPKG

foop

Version:

interfaces that describe their intentions.

github.com/fluents/chain-able

fluents/chain-able

149 lines (128 loc) ā€¢ 7.55 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# ā›“ chain-able [![NPM version][chain-able-npm-image]][chain-able-npm-url] [![docs](https://img.shields.io/badge/šŸ“–-docs-blue.svg)](https://github.com/fluents/chain-able/wiki) [![Dependencies][david-deps-img]][david-deps-url] [![fliphub][gitter-badge]][gitter-url] [![BuildStatus](https://travis-ci.org/fluents/awesome-fluents.svg?branch=master)](https://travis-ci.org/fluents/awesome-fluents) [![Coverage Status](https://coveralls.io/repos/github/fluents/chain-able/badge.svg?branch=master)](https://coveralls.io/github/fluents/chain-able?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b1d92a30c4aa43df9a6233cfadde2307)](https://www.codacy.com/app/aretecode/chain-able?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=fluents/chain-able&amp;utm_campaign=Badge_Grade) [![gzip size](http://img.badgesize.io/https://unpkg.com/chain-able@4.0.6/dists/amd/index.js?compression=gzip)](https://unpkg.com/chain-able@4.0.6) [![fluent](https://img.shields.io/badge/ā›“-fluent-9659F7.svg)](https://github.com/fluents/awesome-fluents) [![fluent](https://img.shields.io/badge/šŸŽ”-playground-black.svg)](https://aretecode.github.io/chain-able-playground/) [david-deps-img]: https://img.shields.io/badge/0-dependencies-blue.svg [david-deps-url]: https://david-dm.org/fluents/chain-able [chain-able-npm-image]: https://img.shields.io/npm/v/chain-able.svg [chain-able-npm-url]: https://npmjs.org/package/chain-able [license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat [license-url]: https://spdx.org/licenses/MIT [gitter-badge]: https://img.shields.io/gitter/room/fliphub/pink.svg [gitter-url]: https://gitter.im/fliphub/Lobby [wiki]: https://github.com/fluents/chain-able/wiki [deps]: https://github.com/fluents/chain-able/wiki/deps [parent]: https://github.com/fluents/chain-able/wiki/parent [analogy]: https://github.com/fluents/chain-able/wiki/analogy [Observe]: https://github.com/fluents/chain-able/wiki/Observe [DotProp]: https://github.com/fluents/chain-able/wiki/DotProp [Schema]: https://github.com/fluents/chain-able/wiki/Schema [Transform]: https://github.com/fluents/chain-able/wiki/Transform [Shorthand]: https://github.com/fluents/chain-able/wiki/Shorthand [API]: https://github.com/fluents/chain-able/wiki/api [compose]: https://github.com/fluents/chain-able/wiki/Compose [Chainable]: https://github.com/fluents/chain-able/wiki/Chainable [ChainedMap]: https://github.com/fluents/chain-able/wiki/ChainedMap [ChainedSet]: https://github.com/fluents/chain-able/wiki/ChainedSet [FactoryChain]: https://github.com/fluents/chain-able/wiki/FactoryChain [MergeChain]: https://github.com/fluents/chain-able/wiki/MergeChain [MethodChain]: https://github.com/fluents/chain-able/wiki/MethodChain [TraverseChain]: https://github.com/fluents/chain-able/wiki/TraverseChain [CHANGELOG]: https://github.com/fluents/chain-able/blob/master/docs/CHANGELOG.md [Snippet]: https://github.com/fluents/chain-able/wiki/Snippet [Examples]: https://github.com/fluents/chain-able/wiki/Examples [ExamplesPrimitives]: https://github.com/fluents/chain-able/wiki/Primitives [ExamplesLocalStorage]: https://github.com/fluents/chain-able/wiki/LocalStorage [ExamplesExpressive]: https://github.com/fluents/chain-able/wiki/LocalStorage [ExamplesComparison]: https://github.com/fluents/chain-able/wiki/Comparison [ExamplesIteratable]: https://github.com/fluents/chain-able/wiki/Iteratable [TypeDefs]: https://github.com/fluents/chain-able/tree/master/typings [Tests]: https://github.com/fluents/chain-able/tree/master/test [Src]: https://github.com/fluents/chain-able/tree/master/src [map]: https://ponyfoo.com/articles/es6-maps-in-depth [set]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Set [cov]: https://coveralls.io/github/fluents/chain-able?branch=master > interfaces that describe their intentions ā— chain-able now has a website! [šŸ”— chain-able.js.org](https://chain-able.js.org) ### šŸ“¦ install ```bash 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][wiki] - [runtime type validation][Schema] - [šŸ”¬ 300+ tests][Tests] with [96%+ code coverage][cov] - āš” [performant & tiny][Src] `~8kb` _(gzip)_ [_300 byte_ minimal version available as snippet][snippet] <details><summary><em><b>more...</b></em></summary> - [šŸŒ api][API] - [ā›“ Chainable][Chainable] - [šŸ—ŗ ChainedMap][ChainedMap] - [šŸ”¢ ChainedSet][ChainedSet] - [šŸ“ extends Map & Set, same transparent api][map] - [šŸ”£ symbols to make usage even easier][Chainable] - [šŸ­ iteratable][ExamplesIteratable] - [šŸ—£ expressive][ExamplesExpressive] - [šŸ‘¾ makes solving complex problems simple][Examples] - [šŸ’† seamless native integration][ExamplesPrimitives] - [šŸŽ¼ compose & decorate][compose] - [šŸ‘‚ observe with Wildcard/Glob, RegExp, Functions][Observe] - [šŸ¤– transform][Transform] - [šŸ•µ debug][Shorthand] - [šŸ‘£ traverse **any** data][TraverseChain] - [āš–ļø fast deepEquals][Transform] - [šŸ—ŗ remap][Transform] - [šŸ‘† tap][ChainedMap] - [šŸ”‹ toggleable dot.prop][DotProp] - [šŸ– shorthands, wrap, return, setIfEmpty][Shorthand] - [šŸ›‚ types, schemas, validation][Schema] - [šŸ”Œ method builder][MethodChain] - [`onCall`][MethodChain] - [`onSet`][MethodChain] - [`onGet`][MethodChain] - [`type`][MethodChain] - [`define`][MethodChain] - [`getSet`][MethodChain] - [`default`][MethodChain] - [`initial`][MethodChain] - [`bind`][MethodChain] - [`camelCase`][MethodChain] - [`autoIncrement`][MethodChain] - [`factory`][MethodChain] - [`returns`][MethodChain] - [`callReturns`][MethodChain] - [`decorate (any object!)`][MethodChain] - [šŸ­ infinitely nestable understandable factories][FactoryChain] - [ā–¶ļøā—€ļø easy deep merging][MergeChain] - [ā˜®ļø compatibility - typescript, nodejs, webpack, rollup, fusebox, babel, buble, amd][API] </details> ----- ### šŸ”— related - [šŸ˜Žā›“ awesome fluents](https://github.com/fluents/awesome-fluents) - many thanks to [Eli Perelman](https://github.com/eliperelman) for all the chainable goodness - thanks to [James Halliday](https://github.com/substack) for the tremendous [traversals](https://github.com/substack/js-traverse) - thanks to [Sindre Sorhus](https://github.com/sindresorhus) for the simple [dot-prop](https://github.com/sindresorhus/dot-prop) access - thanks to [Josh Duff](https://github.com/KyleAMathews) for [deep merging](https://github.com/KyleAMathews/deepmerge) - based on [webpack-chain](https://github.com/mozilla-rpweb/webpack-chain), but not webpack-specific. - thanks to [Jon Schlinkert](https://github.com/jonschlinkert/kind-of) & [inferno](https://github.com/infernojs/inferno/blob/master/packages/inferno-shared/src/index.ts) for type checking inspirations - transpiled with [buble](https://gitlab.com/Rich-Harris/buble) - [Martin Fowler on FluentInterface](https://www.martinfowler.com/bliki/FluentInterface.html) - [ramda](https://github.com/ramda/ramda) & [lodash](https://github.com/lodash/lodash) for some well tested & documented utilities (currying, mapping)