Skip to content

Commit

Permalink
docs change
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnfeldman committed Apr 6, 2016
1 parent d40dd35 commit ed13c7d
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,26 @@ must contain an init method which returns an object literal with all of the hand

init method must return an object with handler methods for each event

the available handlers are
the available handlers are

* on_request
* ondata_request
* ondata_request
* onend_request
* on_response
* ondata_response
* onend_response
* onclose_response
* onerror_response

the handler signature will look like
the handler signature will look like

```javascript
function(sourceRequest,sourceResponse,[options],next){}
```
* sourceRequest: the request from the northbound server
* sourceResponse the response to the northbound server
* options: are the full scope of fields you might need to operate on.
```javascript
* options: are the full scope of fields you might need to operate on.

```javascript
const options = {
targetResponse: options.targetResponse,
targetRequest: options.targetRequest,
Expand All @@ -47,6 +46,6 @@ function(sourceRequest,sourceResponse,[options],next){}
```
* you must call next with an error if you errored out like

```javascript
```javascript
next([err])
```

0 comments on commit ed13c7d

Please sign in to comment.