Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhoukekestar/custom-decorators
https://github.com/zhoukekestar/custom-decorators
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/zhoukekestar/custom-decorators
- Owner: zhoukekestar
- License: mit
- Created: 2024-07-15T09:38:52.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T03:05:07.000Z (2 months ago)
- Last Synced: 2024-09-18T06:21:58.114Z (2 months ago)
- Language: JavaScript
- Size: 46.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# custom Open Technical Architecture
[](https://www.npmjs.com/package/custom-decorators)
[](https://www.npmjs.com/package/custom-decorators)
Easily extend and enhance existing code using a standard decorator syntax.
The extension plugin is written following the style of `Koa Middleware`.
# Quick Start
```js
import custom from 'custom-decorators';
class ClassA {
// Just add a `@custom` decorator and the extension name.
@custom('ClassA.method')
// No need to modify something for the function
async method(name) {
console.log(`hello ${name}`);
}
}
// Add a middleware to extend the method
custom('ClassA.method', async function(context, next) {
// Get the arguments from the context
const { args } = context;
console.log(this, 'before', args[0]);
await next();
console.log(this, 'after', args[0]);
})
const instancea = new ClassA();
// invoke the original method as usual
instancea.method('world');
/* output
ClassA {} before world
hello world
ClassA {} after world
*/
```
# Architecture
# Features
* Support both `async` and `sync` functions depending on your declaration.
```js
class ClassA {
@custom('ClassA.method')
method(name) {
console.log(`hello ${name}`);
}
}
// Note that the original function is synchronous, so the plugin function should also be sync.
// DO NOT add the `async` keyword.
custom('ClassA.method', function(context, next) {
const { args } = context;
console.log(this, 'before', args[0]);
next();
console.log(this, 'after', args[0]);
})
```
* Support the return value.
```js
class ClassA {
@custom('ClassA.method')
async get(name) {
return `hello ${name}`;
}
}
// Get & modify the return value
custom('ClassA.method', async function(context, next) {
const returnValue = await next();
return `before ${returnValue} after`;
})
const instancea = new ClassA();
console.log(instancea.get('world'));
/* output
before hello world after
*/
```
* Support for private extension (by not exports your symbol objects)
```js
const PRIVATE_EXTENSION = Symbol('private_extension');
class ClassA {
@custom(PRIVATE_EXTENSION)
async method(name) {
console.log(`hello ${name}`);
}
}
custom(PRIVATE_EXTENSION, async function(context, next) {
// code gos here
})
```
## License
[MIT](https://opensource.org/licenses/MIT)
Copyright (c) 2024-present, Zhoukekestar