diff --git a/.projenrc.ts b/.projenrc.ts index 1bba55e..6bd9181 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -1,14 +1,14 @@ -import { CdklabsConstructLibrary } from "cdklabs-projen-project-types"; +import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types'; const project = new CdklabsConstructLibrary({ - author: "AWS", - authorAddress: "aws-cdk-dev@amazon.com", - cdkVersion: "2.1.0", - defaultReleaseBranch: "main", - devDeps: ["cdklabs-projen-project-types"], - name: "cdk-verified-permissions", + author: 'AWS', + authorAddress: 'aws-cdk-dev@amazon.com', + cdkVersion: '2.1.0', + defaultReleaseBranch: 'main', + devDeps: ['cdklabs-projen-project-types'], + name: 'cdk-verified-permissions', projenrcTs: true, release: false, - repositoryUrl: "https://github.com/cdklabs/cdk-verified-permissions.git", + repositoryUrl: 'https://github.com/cdklabs/cdk-verified-permissions.git', // deps: [], /* Runtime dependencies of this module. */ // description: undefined, /* The description is just a string that helps people understand the purpose of the package. */ diff --git a/API.md b/API.md new file mode 100644 index 0000000..dd4c4b6 --- /dev/null +++ b/API.md @@ -0,0 +1,39 @@ +# API Reference + + + +## Classes + +### Hello + +#### Initializers + +```typescript +import { Hello } from 'cdk-verified-permissions' + +new Hello() +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| sayHello | *No description.* | + +--- + +##### `sayHello` + +```typescript +public sayHello(): string +``` + + + + + diff --git a/yarn.lock b/yarn.lock index 42bc02c..ece6246 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1639,9 +1639,9 @@ downlevel-dts@^0.11.0: typescript next electron-to-chromium@^1.4.648: - version "1.4.648" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.648.tgz#c7b46c9010752c37bb4322739d6d2dd82354fbe4" - integrity sha512-EmFMarXeqJp9cUKu/QEciEApn0S/xRcpZWuAm32U7NgoZCimjsilKXHRO9saeEW55eHZagIDg6XTUOv32w9pjg== + version "1.4.650" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.650.tgz#b38ef9de16991b9f7b924246770576ab91ab3d64" + integrity sha512-sYSQhJCJa4aGA1wYol5cMQgekDBlbVfTRavlGZVr3WZpDdOPcp6a6xUnFfrt8TqZhsBYYbDxJZCjGfHuGupCRQ== emittery@^0.13.1: version "0.13.1"