ข้ามไปยังเนื้อหาหลัก

โครงสร้างไฟล์ของตัวเชื่อมต่อ (Connector)

ด้านล่างนี้เป็นโครงสร้างไฟล์ตัวอย่าง เพื่อแสดงให้เห็นว่าไฟล์ของตัวเชื่อมต่อ (Connectors) ถูกจัดระเบียบอย่างไรในโปรเจกต์ TypeScript

ไฟล์ที่ลงท้ายชื่อด้วย ^ หมายถึงไฟล์ที่เป็นตัวเลือก (optional) หากไม่มีเครื่องหมายนี้ถือว่าเป็นไฟล์ที่จำเป็น (required)

ConnectorRootDir/
├── package.json
├── README.md
├── logo.svg
├── logo-dark.svg^
└── src/
    ├── index.ts
    ├── index.test.ts
    ├── types.ts
    ├── constant.ts
    ├── mock.ts^
    ├── utils.ts^
    ├── utils.test.ts^
    └── ...

จากโครงสร้างไฟล์ของตัวเชื่อมต่อ (Connector) มาดูรายละเอียดของแต่ละไฟล์และวิธีการทำงานร่วมกันเป็นระบบเดียว

package.json​

package.json เก็บการตั้งค่าคอนฟิกของรีโปตัวเชื่อมต่อนี้ โดยจะถูกรวมกับ package.json กลางที่ใช้ร่วมกัน ซึ่งมี dependencies และ attributes ทั่วไป

README.md​

README.md คือคู่มืออธิบายรายละเอียดสำหรับการตั้งค่าคอนฟิกของตัวเชื่อมต่อ

logo.svg​

logo.svg คือไฟล์ที่เก็บโลโก้ของตัวเชื่อมต่อในรูปแบบเวกเตอร์

logo-dark.svg​

ไฟล์ logo-dark.svg เก็บกราฟิกเวกเตอร์ของโลโก้ตัวเชื่อมต่อสำหรับโหมดมืด

บันทึก:

ดู โลโก้ของตัวเชื่อมต่อ เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับความสัมพันธ์ระหว่าง logo.svg และ logo-dark.svg

index.ts​

index.ts คือไฟล์สำหรับการ implement คลาสของตัวเชื่อมต่อ

index.test.ts​

index.test.ts คือไฟล์ที่เก็บ unit test (UT) ที่เกี่ยวข้องกับการ implement ใน index.ts

types.ts​

types.ts คือที่ที่คุณควรประกาศชนิดของตัวแปรต่าง ๆ

constant.ts​

constant.ts คือที่ที่ควรเก็บค่าคงที่ (constants) ที่เกี่ยวข้องกับตัวเชื่อมต่อ เช่น endpoints, ข้อมูลเมตาของตัวเชื่อมต่อ ฯลฯ

mock.ts​

mock.ts คือไฟล์ที่คุณอาจใส่ค่าจำลอง (mocked values) สำหรับการทดสอบ

utils.ts​

utils.ts คือไฟล์ที่นักพัฒนาจะใส่ฟังก์ชันอรรถประโยชน์ (utility functions) และ utils.test.ts ควรเก็บ UT ที่เกี่ยวข้อง