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

クライアント SDK

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

Squid Client SDKは、Squid AI solutions、databaseおよびAPI connectors、authentication、backend functionsなどのSquid機能とアプリケーションを接続するための主要な方法です。

Client SDKの機能のほとんどはlocal-first(ローカルファースト)であり、これはデータベースレコードへの更新が即座にローカルで反映され、その後サーバーと同期されることを意味します。これにより、Squidはあなたのアプリケーションにリアルタイムの更新を提供することができます。

Note

Client SDKはフロントエンドおよびカスタムバックエンド開発の両方で利用可能です。これにより、フロントエンドアプリケーションとバックエンド functionsの両方でSDKを使用でき、より良いコード共有とシンプルな開発プロセスを実現します。

Squidバックエンドでは、Client SDKは初期化を必要とせずにすぐに利用可能です。拡張されたSquidServiceクラス内でthis.squidを使用して直接アクセスできます。

Client SDK セットアップ​

Client SDKをインストールするには、npmを使用してください:

npm install @squidcloud/client

Squidクライアントは、さまざまなフレームワークとプラットフォームで利用可能です。Squidクライアントを初期化するには、SDKからSquidクラスをインポートし、appId、region、およびenvironmentIdを渡してSquidクライアントのインスタンスを作成してください。ローカル開発の場合は、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が提供する機能の詳細については、managing database data、AI agents and workflows、Squid storage bucket connectors、およびAPI connectorsのドキュメントをご覧ください。

探している機能が見つかりませんか？ あなたのプロジェクトサポートのために Reach out to us までお問い合わせください！