-
Notifications
You must be signed in to change notification settings - Fork 29.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PR-URL: #44929 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
- Loading branch information
1 parent
c80cf97
commit 2901abe
Showing
72 changed files
with
10,995 additions
and
1,374 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
#Interface: DispatchInterceptor | ||
|
||
Extends: `Function` | ||
|
||
A function that can be applied to the `Dispatcher.Dispatch` function before it is invoked with a dispatch request. | ||
|
||
This allows one to write logic to intercept both the outgoing request, and the incoming response. | ||
|
||
### Parameter: `Dispatcher.Dispatch` | ||
|
||
The base dispatch function you are decorating. | ||
|
||
### ReturnType: `Dispatcher.Dispatch` | ||
|
||
A dispatch function that has been altered to provide additional logic | ||
|
||
### Basic Example | ||
|
||
Here is an example of an interceptor being used to provide a JWT bearer token | ||
|
||
```js | ||
'use strict' | ||
|
||
const insertHeaderInterceptor = dispatch => { | ||
return function InterceptedDispatch(opts, handler){ | ||
opts.headers.push('Authorization', 'Bearer [Some token]') | ||
return dispatch(opts, handler) | ||
} | ||
} | ||
|
||
const client = new Client('https://localhost:3000', { | ||
interceptors: { Client: [insertHeaderInterceptor] } | ||
}) | ||
|
||
``` | ||
|
||
### Basic Example 2 | ||
|
||
Here is a contrived example of an interceptor stripping the headers from a response. | ||
|
||
```js | ||
'use strict' | ||
|
||
const clearHeadersInterceptor = dispatch => { | ||
const { DecoratorHandler } = require('undici') | ||
class ResultInterceptor extends DecoratorHandler { | ||
onHeaders (statusCode, headers, resume) { | ||
return super.onHeaders(statusCode, [], resume) | ||
} | ||
} | ||
return function InterceptedDispatch(opts, handler){ | ||
return dispatch(opts, new ResultInterceptor(handler)) | ||
} | ||
} | ||
|
||
const client = new Client('https://localhost:3000', { | ||
interceptors: { Client: [clearHeadersInterceptor] } | ||
}) | ||
|
||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.