From fff5b9f9beb43157b6eca75bb7e2bc45a365521b Mon Sep 17 00:00:00 2001 From: Roger Chi Date: Sat, 24 Dec 2022 09:26:12 -0500 Subject: [PATCH] fix: update --- API.md | 106 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 53 insertions(+), 53 deletions(-) diff --git a/API.md b/API.md index 30b3379..f30f04a 100644 --- a/API.md +++ b/API.md @@ -2,39 +2,39 @@ ## Constructs -### RemixApp +### RemixApp -#### Initializers +#### Initializers ```typescript -import { RemixApp } from 'cdk-remix-app' +import { RemixApp } from '@rogerchi/cdk-remix-app' new RemixApp(scope: Construct, id: string, __2: RemixAppProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| __2 | RemixAppProps | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| __2 | RemixAppProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `__2`Required +##### `__2`Required -- *Type:* RemixAppProps +- *Type:* RemixAppProps --- @@ -42,11 +42,11 @@ new RemixApp(scope: Construct, id: string, __2: RemixAppProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | +| toString | Returns a string representation of this construct. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -58,21 +58,21 @@ Returns a string representation of this construct. | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### ~~`isConstruct`~~ +##### ~~`isConstruct`~~ ```typescript -import { RemixApp } from 'cdk-remix-app' +import { RemixApp } from '@rogerchi/cdk-remix-app' RemixApp.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -84,14 +84,14 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cdnDistributionId | string | *No description.* | -| cdnDomainName | string | *No description.* | -| handler | aws-cdk-lib.aws_lambda.Function | *No description.* | +| node | constructs.Node | The tree node. | +| cdnDistributionId | string | *No description.* | +| cdnDomainName | string | *No description.* | +| handler | aws-cdk-lib.aws_lambda.Function | *No description.* | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -103,7 +103,7 @@ The tree node. --- -##### `cdnDistributionId`Required +##### `cdnDistributionId`Required ```typescript public readonly cdnDistributionId: string; @@ -113,7 +113,7 @@ public readonly cdnDistributionId: string; --- -##### `cdnDomainName`Required +##### `cdnDomainName`Required ```typescript public readonly cdnDomainName: string; @@ -123,7 +123,7 @@ public readonly cdnDomainName: string; --- -##### `handler`Required +##### `handler`Required ```typescript public readonly handler: Function; @@ -136,12 +136,12 @@ public readonly handler: Function; ## Structs -### RemixAppProps +### RemixAppProps -#### Initializer +#### Initializer ```typescript -import { RemixAppProps } from 'cdk-remix-app' +import { RemixAppProps } from '@rogerchi/cdk-remix-app' const remixAppProps: RemixAppProps = { ... } ``` @@ -150,15 +150,15 @@ const remixAppProps: RemixAppProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| remixPath | string | *No description.* | -| cognitoAuth | RemixCognitoAuthProps | *No description.* | -| customDomain | RemixCustomDomainProps | *No description.* | -| ddbSessions | boolean | *No description.* | -| isDev | boolean | *No description.* | +| remixPath | string | *No description.* | +| cognitoAuth | RemixCognitoAuthProps | *No description.* | +| customDomain | RemixCustomDomainProps | *No description.* | +| ddbSessions | boolean | *No description.* | +| isDev | boolean | *No description.* | --- -##### `remixPath`Required +##### `remixPath`Required ```typescript public readonly remixPath: string; @@ -168,27 +168,27 @@ public readonly remixPath: string; --- -##### `cognitoAuth`Optional +##### `cognitoAuth`Optional ```typescript public readonly cognitoAuth: RemixCognitoAuthProps; ``` -- *Type:* RemixCognitoAuthProps +- *Type:* RemixCognitoAuthProps --- -##### `customDomain`Optional +##### `customDomain`Optional ```typescript public readonly customDomain: RemixCustomDomainProps; ``` -- *Type:* RemixCustomDomainProps +- *Type:* RemixCustomDomainProps --- -##### `ddbSessions`Optional +##### `ddbSessions`Optional ```typescript public readonly ddbSessions: boolean; @@ -198,7 +198,7 @@ public readonly ddbSessions: boolean; --- -##### `isDev`Optional +##### `isDev`Optional ```typescript public readonly isDev: boolean; @@ -208,12 +208,12 @@ public readonly isDev: boolean; --- -### RemixCognitoAuthProps +### RemixCognitoAuthProps -#### Initializer +#### Initializer ```typescript -import { RemixCognitoAuthProps } from 'cdk-remix-app' +import { RemixCognitoAuthProps } from '@rogerchi/cdk-remix-app' const remixCognitoAuthProps: RemixCognitoAuthProps = { ... } ``` @@ -222,12 +222,12 @@ const remixCognitoAuthProps: RemixCognitoAuthProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| authDomain | string | *No description.* | -| userPool | aws-cdk-lib.aws_cognito.IUserPool | *No description.* | +| authDomain | string | *No description.* | +| userPool | aws-cdk-lib.aws_cognito.IUserPool | *No description.* | --- -##### `authDomain`Required +##### `authDomain`Required ```typescript public readonly authDomain: string; @@ -237,7 +237,7 @@ public readonly authDomain: string; --- -##### `userPool`Required +##### `userPool`Required ```typescript public readonly userPool: IUserPool; @@ -247,12 +247,12 @@ public readonly userPool: IUserPool; --- -### RemixCustomDomainProps +### RemixCustomDomainProps -#### Initializer +#### Initializer ```typescript -import { RemixCustomDomainProps } from 'cdk-remix-app' +import { RemixCustomDomainProps } from '@rogerchi/cdk-remix-app' const remixCustomDomainProps: RemixCustomDomainProps = { ... } ``` @@ -261,12 +261,12 @@ const remixCustomDomainProps: RemixCustomDomainProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | *No description.* | -| domainName | string | *No description.* | +| certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | *No description.* | +| domainName | string | *No description.* | --- -##### `certificate`Required +##### `certificate`Required ```typescript public readonly certificate: ICertificate; @@ -276,7 +276,7 @@ public readonly certificate: ICertificate; --- -##### `domainName`Required +##### `domainName`Required ```typescript public readonly domainName: string;