Merge pull request #2314 from srchase/cloudfront-signer-documentation

improved documentation for #2308
aws · Oct 22, 2018 · 4d6aa8b · 4d6aa8b
2 parents 0771420 + eceed60
commit 4d6aa8b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/cloudfront/signer.js b/lib/cloudfront/signer.js
@@ -157,7 +157,8 @@ AWS.CloudFront.Signer = inherit({
      *
      * @param options [Object]          The options to create a signed URL.
      * @option options url [String]     The URL to which the signature will grant
-     *                                  access. Required.
+     *                                  access. Any query params included with
+     *                                  the URL should be encoded. Required.
      * @option options expires [Number] A Unix UTC timestamp indicating when the
      *                                  signature should expire. Required unless you
      *                                  pass in a full policy.