API リファレンス

API リファレンスは利用者別に分かれています。アプリケーションコードは Application API から読み始め、データベースやキャッシュの拡張を作る場合だけ Extension API を参照してください。

以下のページでは、公開 API を利用場面ごとに例とともに説明します。すべての export や正確なジェネリックシグネチャを確認する場合は、TypeScript ソースから生成された日本語の型インデックスを参照してください。

アプリケーション API

text

Toshihiko
└── define() が Model を返す
    ├── where() などが Query を返す
    └── build() または検索が Yukari を返す

ページ	内容
Toshihiko	データベース設定、`define()`、Raw 実行
Model	Schema、カスタムメソッド、クエリ入口、トランザクション
Query	条件、フィールド、順序、制限、読み書き
Yukari	行、検証、永続化、シリアライズ
Field と Type	Schema 定義、組み込み型、Validator、カスタム型

以下は Adapter と Cache の開発者向けです。既存 Adapter を使うアプリケーションには不要です。

ページ	パッケージ
Adapter	`toshihiko`、`@toshihiko/base-adapter`
Cache	Cache 契約、基底クラス、Redis、Memcached
MySQL Adapter	`@toshihiko/mysql-adapter`
SQL ユーティリティ	`@toshihiko/sql-utils`