kintone-dts-gen
本頁面使用機器翻譯而成。
機器翻譯免責聲明
關於kintone-dts-gen
kintone-dts-gen是用於生成kintone應用的TypeScript類型定義檔(.d.ts)的CLI工具。
使用此工具可批量創建kintone應用的欄位類型。
使用TypeScript開發kintone定製時,可以更高效地工作。
GitHub
https://github.com/kintone/js-sdk/tree/main/packages/dts-gen
授權
文件
https://github.com/kintone/js-sdk/blob/main/packages/dts-gen/README.md
下準備
kintone-dts-gen需要 Node.js 和 npm(一個包管理工具)才能運行。
安裝 Node.js 時,會自動安裝 npm。
-
Node.js 從官方網站下載安裝程式。
Node.js官方網站
要查找所需的 Node.js版本,請確認以下存儲庫中的 engines 屬性:
packages/dts-gen/package.json
例如,以下要求Node.js版本 18 或更高版本。1 2 3
"engines": { "node": ">=18" },
-
運行下載的安裝程式並按照畫面上的說明進行設置。
Quickstart
準備kintone應用,並使用kintone-dts-gen生成應用的類型定義檔。
Step1:準備kintone應用
- 使用以下欄位建立kintone應用:
- 在您創建的應用的 URL 中,找到應用 ID。
URL 中 https://sample.cybozu.com/k/123 末尾的數位是應用ID。
在上述情況下,應用ID為「123」。
Step2:安裝所需的套件
安裝kintone-dts-gen。
|
|
Step2:建立配置檔
以下命令為您的應用生成類型定義檔。
|
|
如果成功,類型定義檔將位於執行命令的目錄中。fields.d.ts
已創建。
補充
關於已創建的類型定義檔的使用方法,請參考以下頁面。
JavaScript 定制中級 (5) - TypeScript
它還支持使用者名和密碼身份驗證,以及 API 和 OAuth 令牌。