diff --git a/API.md b/API.md index d0bd646..d81363c 100644 --- a/API.md +++ b/API.md @@ -3,16 +3,33 @@ ## Structs -### Naming +### NamingOptions -#### Initializer +#### Initializer ```typescript import { ResourceNaming } from '@gammarers/aws-resource-naming' -const naming: ResourceNaming.Naming = { ... } +const namingOptions: ResourceNaming.NamingOptions = { ... } ``` +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| naming | @gammarers/aws-resource-naming.ResourceNaming.NamingType \| {[ key: string ]: string} | *No description.* | + +--- + +##### `naming`Required + +```typescript +public readonly naming: NamingType | {[ key: string ]: string}; +``` + +- *Type:* @gammarers/aws-resource-naming.ResourceNaming.NamingType | {[ key: string ]: string} + +---