Merge pull request #14 from gammarers/feature/type-to-interface

feat: type to interface
gammarers · Nov 27, 2024 · 6fc217c · 6fc217c
2 parents 9b27726 + 040c2a8
commit 6fc217c
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 5 deletions.
diff --git a/API.md b/API.md
diff --git a/src/index.ts b/src/index.ts
@@ -14,11 +14,11 @@ export enum ResourceNamingType {
   CUSTOM = 'Custom',
 }
 
-export type ResourceAutoNaming = {
+export interface ResourceAutoNaming {
   readonly type: ResourceNamingType.AUTO;
 }
 
-export type ResourceDefaultNaming = {
+export interface ResourceDefaultNaming {
   readonly type: ResourceNamingType.DEFAULT;
 }
 
@@ -64,6 +64,7 @@ export namespace ResourceNaming {
   //  function getValueByKey<K extends keyof MyObject>(obj: MyObject, key: K): MyObject[K] {
   //    return obj[key];
   //  }
+  type ResourceNamingOption = ResourceAutoNaming | ResourceDefaultNaming | {type: ResourceNamingType.CUSTOM; [key: string]: string};
 
   //  export type NamingOptions = {
   //    naming: ResourceNaming.AutoNaming | ResourceNaming.DefaultNaming | {type: ResourceNaming.NamingType.CUSTOM; names: {[key: string]: string}};
@@ -79,7 +80,7 @@ export namespace ResourceNaming {
     //    resourceNaming?: {
     //      naming: ResourceNaming.AutoNaming | ResourceNaming.DefaultNaming | {type: ResourceNaming.NamingType.CUSTOM; names: {[key: string]: string}};
     //    }) {
-    resourceNaming?: ResourceAutoNaming | ResourceDefaultNaming | {type: ResourceNamingType.CUSTOM; [key: string]: string}) {
+    resourceNaming?: ResourceNamingOption) {
     return Object.fromEntries(
       Object.entries(autoNaming).map(([name, value]) => {
         return [name, (() => {

diff --git a/test/naming.test.ts b/test/naming.test.ts
@@ -18,7 +18,7 @@ describe('ResouceNaming Testing', () => {
     functionRoleName: `${random}-func-exc-role`,
   };
 
-  type CustomNaming = {
+  interface CustomNaming {
     readonly type: ResourceNamingType.CUSTOM;
     readonly functionName: 'example-function';
     readonly functionRoleName: 'example-role';
@@ -52,7 +52,7 @@ describe('ResouceNaming Testing', () => {
   });
 
   it('Is Namings', () => {
-    const options: ResourceNamingOption = {
+    const options = {
       type: ResourceNamingType.CUSTOM,
       functionName: 'example-function',
       functionRoleName: 'example-role',