# s3-wrapper

> A simple API for putting and getting private plain text files to and from S3 using AWS2JS

Latest version **0.0.1** (published 2012-04-29) · 0 weekly downloads

## Install

```sh
npm install s3-wrapper
pnpm add s3-wrapper
yarn add s3-wrapper
bun add s3-wrapper
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2012-04-29 |
| First published | 2012-04-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Charlotte Gore |
| Maintainers | CharlotteGore |
| Keywords | amazon, s3, aws2js, aws, api |

## Links

- npm: https://www.npmjs.com/package/s3-wrapper
- Repository: https://github.com/CharlotteGore/S3Wrapper
- Homepage: https://CharlotteGore@github.com/CharlotteGore/S3Wrapper.git
- npm.io page: https://npm.io/package/s3-wrapper

## Dependencies (3)

- [aws2js](https://npm.io/package/aws2js.md) x.x.x
- [underscore](https://npm.io/package/underscore.md) 1.3.x
- [base-framework](https://npm.io/package/base-framework.md) 1.0.x

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2012-04-29

## README

#S3-Wrapper

## Intro

Save a text file and load a text file from a pre-existing Amazon S3 bucket. Uses aws2js.

This absolutely isn't worth a repo of its own but it's a module in something else I'm working on. ;)

### The Code

To install

	npm install s3-wrapper
	// then satisfy the dependencies...
	cd node_modules/s3-wrapper
	npm install

To use

	// get a simply object..
	var s3 = require('s3-wrapper')(key, secret, bucket); // bucket must already exist

	// OR if you want to check the bucket is valid, pass a callback function
	var s3wrapper = require('s3-wrapper');
	var s3 = s3wrapper(key, secret, bucket, function(err, result){

		if(!err){

			// then the bucket exists and we have successfully done a directory listing on it.

		}

	})


	// put a file
	s3.putFile(path, String || Buffer, callback ) // err === false, result === 'ok' if okay.

	// get a file
	s3.getFile(path, callback ) // err === false, result === String if okay.

	// delete a file
	s3.deleteFile(path, callback ) // err === false, result === String if okay.



### Run the tests

To run the tests you need Mocha and Should.js. You should also put your AWS key, secret and a valid bucket you control to use in common.js by editing common.EDIT_ME.js and renaming it to 'common.js'

Then: 

	make test

---
_Source: https://npm.io/package/s3-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._