knox - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

lib/client.js

@@ -121,2 +121,5 @@ /*!
 
+  if ('token' in this)
+    headers['x-amz-security-token'] = this.token;
+
   // Authorization header
@@ -123,0 +126,0 @@ headers.Authorization = auth.authorization({

package.json

@@ -5,3 +5,3 @@ {
   "keywords": ["aws", "amazon", "s3"],
-  "version": "0.4.0",
+  "version": "0.4.1",
   "author": "TJ Holowaychuk <[e-mail]>",
@@ -8,0 +8,0 @@ "contributors": [

Readme.md

@@ -215,2 +215,19 @@ # knox
 
+### Multipart Upload
+
+S3's [multipart upload][] is their [rather-complicated][] way of uploading large
+files. In particular, it is the only way of streaming files without knowing
+their Content-Length ahead of time.
+
+Adding the complexity of multipart upload directly to knox is not a great idea.
+For example, it requires buffering at least 5 MiB of data at a time in memory,
+which you want to avoid if possible. Fortunately, [@nathanoehlman][] has created
+the excellent [knox-mpu][] package to let you use multipart upload with knox if
+you need it!
+
+[multipart upload]: aws.typepad.com/aws/2010/11/amazon-s3-multipart-upload.html
+[rather-complicated]: http://stackoverflow.com/q/8653146/3191
+[@nathanoehlman]: https://github.com/nathanoehlman
+[knox-mpu]: https://npmjs.org/package/knox-mpu
+
 ## Client Creation Options
@@ -264,2 +281,11 @@
 
+### `token`
+
+If you are using the [AWS Security Token Service][sts] APIs, you can construct
+the client with a `token` parameter containing the temporary security
+credentials token. This simply sets the _x-amz-security-token_ header on every
+request made by the client.
+
+[sts]: http://docs.amazonwebservices.com/STS/latest/UsingSTS/Welcome.html
+
 ### `agent`
@@ -266,0 +292,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

31751

increased by3.96%

Lines of code

804

increased by0.25%

Number of lines in readme file

317

increased by8.93%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes