https://github.com/meteor-community-packages/meteor-method-hooks
https://github.com/meteor-community-packages/meteor-method-hooks
hacktoberfest hooks meteor
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/meteor-community-packages/meteor-method-hooks
- Owner: Meteor-Community-Packages
- License: mit
- Created: 2015-08-05T07:49:59.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-30T13:04:48.000Z (6 months ago)
- Last Synced: 2024-12-30T14:19:17.797Z (6 months ago)
- Topics: hacktoberfest, hooks, meteor
- Language: JavaScript
- Homepage: https://atmospherejs.com/seba/method-hooks
- Size: 239 KB
- Stars: 26
- Watchers: 13
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Meteor Method Hooks
## Before/after hooks for Meteor methods
This package extends Meteor with four methods:
* `Meteor.beforeMethod`
* `Meteor.afterMethod`
* `Meteor.beforeAllMethods`
* `Meteor.afterAllMethods`
This package differs from hitchcott:method-hooks in that:
* You can add hooks for all methods
* It works on both client and server
* You can add and remove hooks at runtime.
* After methods can change the methods result
The `beforeMethod` method can be used for securing `Meteor.methods` based on the result of a definable function.
Any `beforeMethod` that throws an error will stop the relevant method and any other hooks from executing.
If you want to prevent further execution without triggering an error, you can just return 'false' from within your hook.
Here's an example for checking user login:
```js
Meteor.beforeMethod('test',function(){
if(!Meteor.userId()) throw new Meteor.Error(403,"Forbidden");
})
```
You can also pass an array of method names as first parameter.
Uses include:
* Security
* Logging
* [insert imaginative idea]
The before methods get the same arguments as the original method,
The after method can get the current result from `this.result` or the error from `this.error`
If it returns a value that is not undefined, then this will replace the original result.
## TODO
* Testing
## Credits
Inspired by: [Chris Hitchcott](https://github.com/hitchcott/meteor-method-hooks), 2015
Maintained until 2022 by [Seba Kerckhof](https://github.com/sebakerckhof)
Maintained since 2022 by Meteor Community Packages