Hooks

Overview
Hooks allows us to handle request based on the request method and URI pattern.
Types
There are two types of hooks - Before and After, each type will apply first or last in order based on the type.
BeforeHook
The before hook will apply first, before any middleware will take place
AfterHook
The after hook will apply last, after the request ends and response returned to the client.
Usage
Basic usage
The Before and After hooks use as decorator for method
1
    @BeforeHook(pattern: string, method?: HTTP_METHOD,  options?: IHookOptions)
2
    beforeHookFn(req, res, next) {
3
        // method to be apply before the endpoint trigger
4
    }
5
    
6
    
7
    @AfterHook(pattern: string, method?: HTTP_METHOD,  options?: IHookOptions)
8
    afterHookFn(req, res, next) {
9
        // method to be apply after the endpoint trigger
10
    }
Copied!
Hook should be end by calling to the next method
Example
1
export class Hooks{
2
    static counter: number = 0
3
    
4
    private logger: Logger;
5
    @BeforeHook('*')
6
    beforeAll(req, res, next) {
7
        res.counter = ++Hooks.counter
8
        next()
9
    }
10
​
11
    @AfterHook('/*/:id', HTTP_METHOD.GET)
12
    afterRead(req, res, next) {
13
        const payload = Object.assign({reqCounter: req['counter']}, req.params)
14
        this.logger.log('read was apply', payload)
15
        next()
16
    }
17
}
Copied!
Priority
We can control the order of hooks apply be setting the hook priority.
Lower the number is, hook priority is higher and will apply earlier
Example
1
export class Hooks{
2
    static counter: number = 0
3
    
4
    private logger: Logger;
5
    @BeforeHook('*', HTTP_METHOD.ALL, {priority: 0}) // apply first
6
    beforeAll(req, res, next) {
7
        res.counter = ++Hooks.counter
8
        next()
9
    }
10
​
11
    @BeforeHook('/*/:id', HTTP_METHOD.GET, {priority: 1})// apply second
12
    beforeRead(req, res, next) {
13
        const payload = Object.assign({reqCounter: req['counter']}, req.params)
14
        this.logger.log('read was apply', payload)
15
        next()
16
    }
17
}
Copied!

@sugoi/server - Previous

Delay module initialization

Next - @sugoi/server

Timeout

Last modified 2yr ago

Copy link

Contents