npm package: @ojdoc/ask-sdk-s3-persistence-adapter
Description: S3 based implementation package of PersistenceAdapter interface in ASK SDK v2 for Node.js based on AWS SDK v3
Author: Ojdoc
Latest version: 1.0.4

ASK SDK S3 Persistence Adapter package contains implementation of persistence adapter in Core SDK ('ask-sdk-core') based on AWS SDK v3.

## Note

Because Amazon S3 provides [eventual consistency](https://docs.aws.amazon.com/AmazonS3/latest/dev/Introduction.html) for updates to existing objects, we recommend using [ask-sdk-dynamodb-persistence-adapter](https://github.com/tianrenz/alexa-skills-kit-sdk-for-nodejs/tree/2.0.x/ask-sdk-dynamodb-persistence-adapter) for persistent attributes if your skill requires read-after-write consistency.

## What is ASK SDK v2 for Node.js

The ASK SDK v2 for Node.js is an open-source Alexa CustomSkill Development Kit. ASK SDK v2 for Node.js makes it easier for you to build highly engaging skills, by allowing you to spend more time on implementing features and less on writing boiler-plate code.

## What is AWS SDK for JavaScript v3

The [AWS SDK for JavaScript v3 API Reference Guide](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html) provides a JavaScript API for AWS services. You can use the JavaScript API to build libraries or applications for [Node.js](https://nodejs.org/en/) or the browser.

## Installing
ASK SDK S3 Persistence Adapter package is an addon package for the core SDK ('ask-sdk-core') and thus has peer dependency of the core SDK package. From within your NPM project, run the following commands in the terminal to install them:

```
npm install --save ask-sdk-core
```

```
npm install --save @ojdoc/ask-sdk-s3-persistence-adapter
```

## Usage and Getting Started

You can find a getting started guide [here](https://developer.amazon.com/docs/alexa-skills-kit-sdk-for-nodejs/manage-attributes.html#s3persistenceadapter).

## Usage with TypeScript
The ASK SDK S3 Persistence Adapter package for Node.js bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files. Our goal is to keep these TypeScript definition files updated with each release for any public api.

### Pre-requisites
Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:
- Use TypeScript v2.x
- Include the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:

```
npm install --save-dev @types/node
```

### In Node.js
To use the TypeScript definition files within a Node.js project, simply import ask-sdk-s3-persistence-adapter as below:

In a TypeScript file:

```typescript
import * as Adapter from '@ojdoc/ask-sdk-s3-persistence-adapter';
```

In a JavaScript file:

```javascript
const Adapter = require('@ojdoc/ask-sdk-s3-persistence-adapter');
```

## Opening Issues
For bug reports, feature requests and questions, we would like to hear about it. Search the [existing issues](https://github.com/cquenum/ask-sdk-s3-persistence-adapter/issues) and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of the SDK, Node.js or browser environment and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.

## License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.