CsvIO

CsvIO 是 NekoJS CSV 的核心類別，提供了 CSV 解析和生成的功能。

注

所有類型是 Path 的參數都可以接受字串。
Path 是一個特殊的類型，允許使用絕對路徑（CWD 為遊戲實例資料夾，常見位置為 .minecraft/）來指定檔案位置。

解析

語法

parse(document: string): object[]

參數

參數名稱	類型	說明
document	string	要解析的 CSV 字串

回傳值

解析後的物件陣列，每個物件代表 CSV 中的一行，屬性名稱對應 CSV 的標題行。

範例

const csvString = `Name,ID,Description
Stone,stone,A common block
Dirt,dirt,Another common block`;

const result = CsvIO.parse(csvString);
console.log(result);

轉換字串

語法

toString(data: object[]): string

參數

參數名稱	類型	說明
data	object[]	要轉換的物件陣列

回傳值

轉換後的 CSV 字串。

範例

const data = [
  {
    "Name": "Stone",
    "ID": "stone",
    "Description": "A common block"
  },
  {
    "Name": "Dirt",
    "ID": "dirt",
    "Description": "Another common block"
  }
];
const csvString = CsvIO.toString(data);
console.log(csvString);

讀取檔案

語法

read(path: Path): object[]

參數

參數名稱	類型	說明
path	Path	要讀取的 CSV 檔案路徑

回傳值

解析後的物件陣列，每個物件代表 CSV 中的一行，屬性名稱對應 CSV 的標題行。

範例

const csvData = CsvIO.read('nekojs/data/blocks.csv');
console.log(csvData);

寫入檔案

語法

write(path: Path, data: object[]): void

參數

參數名稱	類型	說明
path	Path	要寫入的 CSV 檔案路徑
data	object[]	要寫入的物件陣列

範例

const data = [
  {
    "Name": "Stone",
    "ID": "stone",
    "Description": "A common block"
  },
  {
    "Name": "Dirt",
    "ID": "dirt",
    "Description": "Another common block"
  }
];
CsvIO.write('nekojs/data/blocks.csv', data);

刪除 CSV 檔案

語法

delete(path: Path): void

參數

參數名稱	類型	說明
path	Path	要刪除的 CSV 檔案路徑

範例

CsvIO.delete('nekojs/data/blocks.csv');