From b0b7aff4b86ba22e0f720d4ed37b7de6a8b36153 Mon Sep 17 00:00:00 2001 From: Malte-Thorben Bruns Date: Tue, 21 Apr 2015 02:25:07 +0200 Subject: [PATCH] doc/plugin-api: add `call.__request()` --- doc/plugin-api.markdown | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/plugin-api.markdown b/doc/plugin-api.markdown index 0ce5bbe..72108c9 100644 --- a/doc/plugin-api.markdown +++ b/doc/plugin-api.markdown @@ -73,6 +73,11 @@ Registers an interceptor `function(Call, Object, *)` for an event. ### call.\_\_clear() Removes all registered interceptors. +### call.\_\_request() +Create a request object when no request is pending and a configuration is available. When no configuration is available, a _non-interceptable_ error is emitted. + +Returns `true` when a request is pending, otherwise the newly created `request` object. + ### Event: 'request' Emitted one tick after the request object has been created.