https://github.com/stevelin100132/dynamic-class
dynamic-class 是一個用於動態類別實例化的 TypeScript 函式庫，主要目標是更高效地實現 Design Pattern（設計模式）中的簡單工廠（Simple Factory）。透過動態類別裝飾器與動態類別工廠，開發者可以使用別名或類別名稱來動態建立類別實例、降低耦合度，提升擴展性，讓新類別可以無縫整合以及簡化 Factory Pattern 的實作，無需手動維護 Mapping Table。
https://github.com/stevelin100132/dynamic-class
design-patterns nodejs simple-factory-pattern typescript
Last synced: about 2 months ago
JSON representation
dynamic-class 是一個用於動態類別實例化的 TypeScript 函式庫，主要目標是更高效地實現 Design Pattern（設計模式）中的簡單工廠（Simple Factory）。透過動態類別裝飾器與動態類別工廠，開發者可以使用別名或類別名稱來動態建立類別實例、降低耦合度，提升擴展性，讓新類別可以無縫整合以及簡化 Factory Pattern 的實作，無需手動維護 Mapping Table。
- Host: GitHub
- URL: https://github.com/stevelin100132/dynamic-class
- Owner: SteveLin100132
- Created: 2021-11-07T04:59:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T13:48:47.000Z (over 1 year ago)
- Last Synced: 2025-10-22T10:14:21.327Z (8 months ago)
- Topics: design-patterns, nodejs, simple-factory-pattern, typescript
- Language: JavaScript
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# dynamic-class
dynamic-class 是一個用於動態類別實例化的 TypeScript 函式庫，主要目標是更高效地實現 Design Pattern（設計模式）中的簡單工廠（Simple Factory）。透過動態類別裝飾器與動態類別工廠，開發者可以使用別名或類別名稱來動態建立類別實例、降低耦合度，提升擴展性，讓新類別可以無縫整合以及簡化 Factory Pattern 的實作，無需手動維護 Mapping Table。
# Install
```
npm i dynamic-class --save
```
# Table of Contents
- [Feature](#feature)
- [Usage](#usage)
- [Example](#example)
# Feature
- 提供動態實例類別
- 可自訂類別別名，讓產生實例時，可以透過其他名稱實例對應物件
# Usage
### Dynamic Class Decorator
使用添 `@DynamicClass()` 裝飾器，讓要動態實例的類別被記錄
```typescript
import { DynamicClass } from 'wistroni40-dynamic-class';
@DynamicClass()
export class CustomClass implements Custom {
constructor(public property: string) {}
public method() { ... }
}
```
#### @DynamicClass()
該裝飾器提供以下配置
| Paramter | Type | Description |
| -------- | ---------------------- | -------------------------- |
| alias | string | string[] | 可提供單個或多個類別的別名 |
```typescript
// 單個別名
@DynamicClass({
alias: 'AliasName'
})
class MyClass {}
// 多個別名
@DynamicClass({
alias: ['AliasName1', 'AliasName2', ...]
})
class MyClass {}
```
### Dynamic Class Factory
使用 `DynamicClassFactory` 將指定的類別(以 String 給定類別名稱)實例
```typescript
import { DynamicClassFactory } from 'wistroni40-dynamic-class';
const custom = DynamicClassFactory.createInstance(
'CustomClass',
'custom-property',
);
```
##### createInstance()
| Paramter | Type | Description |
| --------- | ------ | -------------------------------------------- |
| classNmae | string | 要實例的類別名稱 |
| ...args | any[] | 實例該類別所需的建構值參數，根據實際數量添加 |
# Example
- [完整範例](https://github.com/SteveLin100132/wistroni40-dynamic-class/blob/master/examples/index.ts)