question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

(docs): Unclear stable package names in ts API Ref

See original GitHub issue

link to reference doc page

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda-readme.html

Describe your issue?

The correct package name in v2 should be aws-cdk-lib/aws-lambda, but it’s aws-cdk-lib » aws_lambda in doc.

It impacts all stable modules.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:11 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
zxkanecommented, Jan 20, 2022

I know all stable packages are built in aws-cdk-lib since v2.

But the developer must import the types like below when uses DynamoDB in typescript,

import { Table, AttributeType, TableEncryption } from 'aws-cdk-lib/aws-dynamodb';
// or
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';

But the documentation like below screenshot really led to import package with wrong name,

image

0reactions
github-actions[bot]commented, May 24, 2022

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.

Read more comments on GitHub >

github_iconTop Results From Across the Web

(docs): Unclear stable package names in ts API Ref · aws/aws-cdk ...
The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code - (docs): Unclear stable package names in ts API...
Read more >
AWS SDK for JavaScript v3
Stability of Modular Packages. Package name, containing folder, API controlled by, stability. @aws-sdk/client-* Commands, clients ...
Read more >
Documentation - TypeScript 3.8
Sometimes we call these private names. Every private field name is uniquely scoped to its containing class. TypeScript accessibility modifiers like public or ......
Read more >
Google TypeScript Style Guide
Code will usually benefit from more documentation than just variable names though! Avoid comments that just restate the parameter name and type, e.g....
Read more >
Migrating to Apollo Server 4 - Apollo GraphQL Docs
Apollo Server 4 takes a different approach to integrations by providing a stable web framework integration API, which includes explicit support for serverless ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found