Merge pull request andrewrk#107 from gswalden/patch-1

faceleg · faceleg · commit d0946f6c4583 · 2015-11-20T15:02:31.000+13:00
add examples section to README.md w/ check if file exists
diff --git a/README.md b/README.md
@@ -600,6 +600,28 @@ Returns an `EventEmitter` with these events:
  * `'copySuccess' (data)`
  * `'end' (data)`
 
+## Examples
+
+### Check if a file exists in S3
+
+Using the AWS SDK, you can send a HEAD request, which will tell you if a file exists at `Key`.
+
+See http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property
+
+```js
+var client = require('s3').createClient({ /* options */ });
+client.s3.headObject({
+  Bucket: 's3 bucket name',
+  Key: 'some/remote/file'
+}, function(err, data) {
+  if (err) {
+    // file does not exist (err.statusCode == 404)
+    return;
+  }
+  // file exists
+});
+```
+
 ## Testing
 
 `S3_KEY=<valid_s3_key> S3_SECRET=<valid_s3_secret> S3_BUCKET=<valid_s3_bucket> npm test`
