Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mako-taco/DecorateThis
JS Decorators library
https://github.com/mako-taco/DecorateThis
Last synced: 3 days ago
JSON representation
JS Decorators library
- Host: GitHub
- URL: https://github.com/mako-taco/DecorateThis
- Owner: mako-taco
- License: apache-2.0
- Created: 2015-05-22T19:07:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-06-08T23:05:21.000Z (over 9 years ago)
- Last Synced: 2024-09-21T11:42:59.236Z (about 1 month ago)
- Language: JavaScript
- Size: 374 KB
- Stars: 538
- Watchers: 9
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - mako-taco/DecorateThis - JS Decorators library (JavaScript)
README
# DecorateThis
Simple, vanilla JS type checking through ES7 decorators
...and a few other decorators, to boot.
- [Installation](#incorporating-in-your-project)
- [Changelog](/docs/CHANGELOG.md)
- Documentation
- [Type validation](#type-validation)
- [param](#type-validation)
- [returns](#type-validation)
- [promises](#promises)
- [Validating Complex Types](/docs/TYPE_VALIDATOR_API.md)
- [memoize](#memoization)
- [debounce](#debouncing)
- [curry](#currying)
- [configurable](#property-descriptors)
- [writable](#property-descriptors)
- [enumerable](#property-descriptors)
If you like this project, be sure to check out [FluxThis](https://github.com/addthis/FluxThis), the immutable Flux framework by [AddThis](http://www.addthis.com).
[](http://badge.fury.io/js/decorate-this)
[](https://travis-ci.org/mako-taco/DecorateThis)
# Type Validation
Throw errors when unexpected types are provided or returned from class or object
functions. For more details, see the [Type Validator API](/docs/TYPE_VALIDATOR_API.md).
```js
import {param, returns} from 'decorate-this';
class Point {
constructor() {
this.x = 0;
this.y = 0;
}
// The first param of this method takes a Point, and will throw
// a type error if a non-Point is passed
@param(Point)
// The method returns a Number. If it doesn't, a type error will
// be thrown before the value is returned.
@returns(Number)
distanceTo(point) {
let squaredDistance = (point.x - this.x) ** 2 +
(point.y - this.y) ** 2;
return Math.sqrt(squaredDistance);
}
// Two number args, no return value
@param(Number)
@param(Number)
addToDimensions(x, y) {
this.x += x;
this.y += y;
}
}
```
# Memoization
Automatically memoize functions for greater efficiency
```js
import memoize from 'decorate-this';
let obj = {
// Results of the function are stored in a map, which maps arguments
// to the function's result. This expensive func is only run a single
// time for a given a/b pair.
@memoize
expensiveFunc(a, b) {
return Math.sin(Math.sqrt(a ** b));
}
};
```
# Property descriptors
```js
import {enumerable, writable, configurable} from 'decorate-this';
class T {
@configurable(false)
@enumerable(false)
@writable(false)
hiddenMethod() {
/* ... */
}
}
```
# Currying
Build up long argument lists with currying
```js
let obj = {
@curry
curriedAdd(a, b, c) {
return a + b + c;
}
}
let addToFive = obj.curriedAdd(5); // Function
let addToFiveAndThree = addToFive(3); // Function
let sum = addToFiveAndThree(7); // 15
```
# Debouncing
Rate-limit expensive or frequently called functions
```js
let obj = {
@debounce(500) // call after 500ms of no further calls
debouncedFn(event) {
console.log(event.clientX, event.clientY);
}
}
```
# Promises
Similar to `returns`, but validates the fulfillment value of a promise
```js
let obj = {
@promises(ArrayOf(Number))
getPoints() {
return new Promise(resolve => {
setTimeout(() => resolve([1, 2, 3]), 5000);
});
}
}
```
# Incorporating in your project
```
npm install decorate-this
```
- Build your project with Babel
- Enable stage 1 (experimental) features
- Profit