@aws/pdk
Version:
All documentation is located at: https://aws.github.io/aws-pdk
55 lines (54 loc) • 1.87 kB
TypeScript
import { TypeSafeApiProject, TypeSafeWebSocketApiProject } from "../../../type-safe-api";
import { ReactTypeScriptProject } from "projen/lib/web";
import { ReactTypeScriptProjectOptions } from "./react-ts-project-options";
/**
* Configuration options for the CloudscapeReactTsWebsiteProject.
*/
export interface CloudscapeReactTsWebsiteProjectOptions extends ReactTypeScriptProjectOptions {
/**
* Name of the application name.
*
* @default "Sample App"
*/
readonly applicationName?: string;
/**
* Public directory.
*
* @default "public"
*/
readonly publicDir?: string;
/**
* Whether to enable self sign-up.
*
* @default false
*/
readonly allowSignup?: boolean;
/**
* TypeSafeApi instance to use when setting up the initial project sample code.
* @deprecated use typeSafeApis
*/
readonly typeSafeApi?: TypeSafeApiProject;
/**
* TypeSafeApi instances to use when setting up the initial project sample code.
*/
readonly typeSafeApis?: TypeSafeApiProject[];
/**
* TypeSafeWebSocketApi instances to use when setting up the initial project sample code
*/
readonly typeSafeWebSocketApis?: TypeSafeWebSocketApiProject[];
}
/**
* Synthesizes a Cloudscape React Typescript Website Project.
*
* @pjid cloudscape-react-ts-website
*/
export declare class CloudscapeReactTsWebsiteProject extends ReactTypeScriptProject {
readonly applicationName: string;
readonly allowSignup: boolean;
readonly publicDir: string;
readonly typeSafeApis?: TypeSafeApiProject[];
readonly typeSafeWebSocketApis?: TypeSafeWebSocketApiProject[];
constructor(options: CloudscapeReactTsWebsiteProjectOptions);
private setupApiExplorer;
private buildSampleDirEntries;
}