Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README is outdated and does not match the current implementation #169

Open
forcia-matsushita opened this issue May 22, 2024 · 0 comments
Open

Comments

@forcia-matsushita
Copy link

I am trying to use this package, but I have noticed that the README seems to be outdated and does not match the current implementation.

For example, the README suggests using the following configuration for createConnection:

import createConnection from "typeorm-aurora-data-api-driver";

const connection = await createConnection({
  type: 'aurora-postgres',
  database: 'test-db',
  secretArn: 'arn:aws:secretsmanager:eu-west-1:537011205135:secret:xxxxxx/xxxxxx/xxxxxx',
  resourceArn: 'arn:aws:rds:eu-west-1:xxxxx:xxxxxx:xxxxxx',
  region: 'eu-west-1',
  serviceConfigOptions: {
    // additional options to pass to the aws-sdk RDS client
  },
  formatOptions: {
    // additional format options to pass to the Data API client
  }
});

However, this configuration does not seem to work with the current version of the package. Additionally, the README mentions using connection.getRepository(Post) , but the connection object does not have a getRepository method.

Could you please update the README with the correct usage instructions for the current version of the package?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant