ts-kintone-package
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

kintoneのプラグイン開発を効率的に行うためのTypeScript対応ライブラリです

公式ドキュメント

本ライブラリのドキュメントは以下です。
『ts-kintone-package』公式ドキュメント

読み込み方法

・npm

npm i ts-kintone-package

・cdn

<script src="https://cdn.jsdelivr.net/npm/ts-kintone-package/dist/index.js"></script>

<script>
const appId = new TSKintone.AppId(1);
</script>

ライブラリ概要

当ライブラリには以下のようなオブジェクトが存在します。

オブジェクト 説明
KintoneApp kintoneの1つのアプリ
KintoneField kintoneアプリの1つのフィールド
KintoneFieldCode kintoneアプリの1つのフィールドのフィールドコード
KintoneFieldType kintoneアプリの1つのフィールドのフィールドタイプ
KintoneRecord kintoneアプリの1レコード

使用方法

本ライブラリの使用方法の例を下記に示します。

全kintoneアプリの情報取得

import { KintoneApp, KintoneAppRepository } from "ts-kintone-package";

const kintoneAppRepository = new KintoneAppRepository()
const apps : KintoneApp[] = await kintoneAppRepository.getAll();

自kintoneアプリの情報取得

import { KintoneApp, KintoneAppRepository } from "ts-kintone-package";

const kintoneAppRepository = new KintoneAppRepository()
const currentApp : KintoneApp = await kintoneAppRepository.getCurrentApp();

自kintoneアプリの全てのフィールドを取得

import { KintoneApp, KintoneAppRepository, KintoneField } from "ts-kintone-package";

const kintoneAppRepository = new KintoneAppRepository()
const currentApp : KintoneApp = await kintoneAppRepository.getCurrentApp();
const fields : Map<string, KintoneField> = currentApp.getFieldsMap();

自kintoneアプリのフィールド「フィールドコード1」のフィールドタイプを取得

import { KintoneApp, KintoneAppRepository } from "ts-kintone-package";

const kintoneAppRepository = new KintoneAppRepository()
const currentApp : KintoneApp = await kintoneAppRepository.getCurrentApp();
const fieldType = currentApp.getFields().getField('フィールドコード1').getFieldType();

Github

本ライブラリのソースは以下で管理しています。
Github

公式ドキュメント

公式ドキュメント

お問い合わせ

本ライブラリに対するお問い合わせは以下からお願いします。
CONTACT FORM

Dependencies (3)

Dev Dependencies (5)

Package Sidebar

Install

npm i ts-kintone-package

Weekly Downloads

0

Version

1.1.0

License

MIT

Unpacked Size

271 kB

Total Files

136

Last publish

Collaborators

  • shun_mitsuoka