Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving plugin implementation documentation #31

Closed
joelwurtz opened this issue Nov 12, 2015 · 3 comments
Closed

Improving plugin implementation documentation #31

joelwurtz opened this issue Nov 12, 2015 · 3 comments

Comments

@joelwurtz
Copy link
Member

@dbu

i am still new to promises. lets integrate the answers of #30 (comment) into the documentation to make things more clear. i guess i am not the only one not familiar with promises, so having more details could help. maybe we should move the "write your own plugin" into its own chapter inside the plugins/ folder. in a way, its the least important, coming after using the existing plugins. it would be cool to show the core code of plugins to explain cases:

  • alter a request
  • alter a response
  • prematurely end a request with a synthetic response (cache, vcr, mocking)
  • start a new request and return that result instead
  • abort a request prematurely with an error
  • abort a response with an error (Error plugin, or for example server validation fails)
@dbu
Copy link
Contributor

dbu commented Feb 1, 2016

many of the plugins are now documented. but i think this is more ideas for the general plugin documentation, right?

@sagikazarmark
Copy link
Member

I think this is about implementing a plugin: async first strategy, restarting the request, etc.

@dbu
Copy link
Contributor

dbu commented Mar 2, 2016

@dbu dbu closed this as completed Mar 2, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants