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

HttpRequest.open and HttpRequest.send method documentation unclear. #1

Open
junzhengca opened this issue Aug 26, 2018 · 0 comments
Open

Comments

@junzhengca
Copy link

junzhengca commented Aug 26, 2018

https://krkrz.github.io/docs/plugin/index.html

Documentation for both methods are extremely unclear, especially for experienced JavaScript coders.

open

HttpRequest.open
   機能/意味
   指定したメソッドで指定URLにリクエストする

I assumed by the description that I will be able to specify a full URL, and this method will actually request the service. However from examples given, it is clear that I can only specify a protocol and a domain name, without payload, even GET payloads.

It won't send the request, which makes ※常に非同期での呼び出しになります this statement false.

send

HttpRequest.send
   機能/意味
   リクエストの送信。送信処理は非同期実行されます。

data	送信するデータ
         octetの場合 : そのまま送信
         文字列の場合 : 規定のエンコードで処理して送信
          その他 : データは送信されません
storeStrorage	レスポンス保存先ファイル。指定された場合はプロパティ responseは 設定されません

This is completely false, by contradiction the example sent GET payload instead within storeStorage parameter.

image

image

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

1 participant