メインコンテンツまでスキップ

クライアント SDK

Squid Client SDK は TypeScript ライブラリで、クライアントアプリケーションが Squid server に接続し、Squid が提供するさまざまなサービスへ安全にアクセスできるようにします。​

Squid Client SDK は、Squid AI solutions、database と API connectors、authentication、backend functions など、Squid の機能とアプリを連携させるための主要な方法です。

Client SDK の機能の多くは local-first であり、データベースレコードの更新は即座にローカルに反映され、その後 server に同期されます。これにより、Squid はアプリケーションに対して real-time updates を提供できます。

Note

Client SDK は、frontend とカスタム backend 開発の両方で利用できます。これにより、frontend アプリケーションと backend functions の両方で SDK を使用でき、より良いコード共有と簡素化された 開発プロセスを実現できます。

Squid backend では、Client SDK は初期化不要ですぐに利用できます。拡張した SquidService クラス内で this.squid を使って直接アクセスできます。

Client SDK のセットアップ​

npm を使用して Client SDK をインストールします:

npm install @squidcloud/client

Squid client は、さまざまなフレームワークやプラットフォームで使用できます。Squid client を初期化するには、SDK から Squid クラスを import し、appId、region、environmentId を渡して Squid client のインスタンスを作成します。ローカル開発では、squidDeveloperId も含めてください。これらの値は Squid Console のアプリケーション概要ページで確認できます:

Client code
import { Squid } from '@squidcloud/client';

const squid = new Squid({
  appId: 'YOUR_APP_ID',
  region: 'YOUR_REGION', // example: 'us-east-1.aws'
  environmentId: 'dev', // or prod
  squidDeveloperId: 'YOUR_SQUID_DEVELOPER_ID',
});

Squid クラスは Squid Client SDK の主要なエントリーポイントとして機能し、Squid のすべての機能へアクセスするための包括的な機能群を提供します。

Client SDK で利用できる内容について詳しくは、データベースデータの管理、AI agents と workflows、Squid storage bucket connectors、および API connectors のドキュメントをご覧ください。

お探しの機能が見つかりませんか？プロジェクトのサポートについては、お問い合わせください!