summaryrefslogtreecommitdiffstatshomepage
path: root/node_modules/undici/docs/api/DispatchInterceptor.md
diff options
context:
space:
mode:
authorEgor Tensin <egor@tensin.name>2026-02-28 21:59:12 +0100
committerEgor Tensin <egor@tensin.name>2026-02-28 22:19:57 +0100
commit9611c248995ad3bacda1d0a93d0b5e1e6605d162 (patch)
treeeb3ae35b426e9d72e7cb34e8e9cc0453745a8e17 /node_modules/undici/docs/api/DispatchInterceptor.md
parentDEVELOPMENT.md: expand on sources (diff)
downloadcleanup-path-9611c248995ad3bacda1d0a93d0b5e1e6605d162.tar.gz
cleanup-path-9611c248995ad3bacda1d0a93d0b5e1e6605d162.zip
upgrade actions/core to version 2
Diffstat (limited to 'node_modules/undici/docs/api/DispatchInterceptor.md')
-rw-r--r--node_modules/undici/docs/api/DispatchInterceptor.md60
1 files changed, 0 insertions, 60 deletions
diff --git a/node_modules/undici/docs/api/DispatchInterceptor.md b/node_modules/undici/docs/api/DispatchInterceptor.md
deleted file mode 100644
index 7dfc260..0000000
--- a/node_modules/undici/docs/api/DispatchInterceptor.md
+++ /dev/null
@@ -1,60 +0,0 @@
-# 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] }
-})
-
-```