From db6d8de5dc6875f12bab2aee565eea36a278354f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 16 Jul 2015 06:32:09 -0700 Subject: [PATCH] docs: Say more about standard scheme --- docs/api/protocol.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index a076e3640daa..2734546516e3 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -37,6 +37,11 @@ Registers a custom protocol of `scheme`, the `handler` would be called with You need to return a request job in the `handler` to specify which type of response you would like to send. +By default the scheme is treated like `http:`, which is parsed differently +from protocols that follows "generic URI syntax" like `file:`, so you probably +want to call `protocol.registerStandardSchemes` to make your scheme treated as +standard scheme. + ## protocol.unregisterProtocol(scheme, callback) * `scheme` String @@ -48,7 +53,11 @@ Unregisters the custom protocol of `scheme`. * `value` Array -`value` is an array of custom schemes to be registered to the standard. +`value` is an array of custom schemes to be registered as standard schemes. + +A standard scheme adheres to what RFC 3986 calls +[generic URI syntax](https://tools.ietf.org/html/rfc3986#section-3). This +includes `file:` and `filesystem:`. ## protocol.isHandledProtocol(scheme, callback)