Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.42 KB

GettingStarted.md

File metadata and controls

31 lines (21 loc) · 1.42 KB
Raw

Getting Started

Minimum Requirements

Before using the AWS Advanced NodeJS Wrapper, you must install:

  • Node 21.0.0+
  • The AWS Advanced NodeJS Wrapper.
  • Your choice of underlying Node driver.
    • To use the wrapper with Aurora with PostgreSQL compatibility, install the PostgreSQL Client.
    • To use the wrapper with Aurora with MySQL compatibility, install the MySQL2 Client.

If you are using the AWS Advanced NodeJS Wrapper as part of a Node project, include the wrapper and underlying driver as dependencies.

Note: Depending on which features of the AWS Advanced NodeJS Wrapper you use, you may have additional package requirements. Please refer to this table for more information.

Obtaining the AWS Advanced NodeJS Wrapper

You can use npm to obtain the AWS Advanced NodeJS Wrapper by adding the following configuration to the application's package.json file:

{
  "dependencies": {
    "aws-advanced-nodejs-wrapper": "^1.0.0"
  }
}

Using the AWS Advanced NodeJS Wrapper

For more detailed information about how to use and configure the AWS Advanced NodeJS Wrapper, please visit this page.