Client SDK

Squid Client SDK は、client application が Squid server に接続し、Squid が提供するさまざまな service に安全に access できる TypeScript library です。

Squid Client SDK は、Squid AI solution、database および API connector、authentication、backend function などを含む Squid feature と app を接続する主な方法です。

Client SDK の機能の大部分は local-first です。つまり、database record の update は直ちにローカルに反映され、その後 server と sync されます。これにより Squid は application に real-time update を提供できます。

注記

Client SDK は frontend と custom backend development の両方で利用できます。これにより、frontend application と backend function の両方で SDK を使用でき、より優れた code sharing と簡略化された development process を実現できます。

Squid backend では、初期化することなく Client SDK をすぐに利用できます。拡張した SquidService class 内で this.squid を使用して直接 access できます。

Client SDK のセットアップ

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

npm install @squidcloud/client

Squid client はさまざまな framework と platform で使用できます。Squid client を初期化するには、SDK から Squid class を import し、appId、region、environmentId を渡して Squid client の instance を作成します。ローカル開発の場合は、squidDeveloperId も含めます。これらの値は、Squid Console の application overview page で確認できます。

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 class は Squid Client SDK の主な entry point として機能し、Squid のすべての feature に access するための包括的な機能群を提供します。

Client SDK が提供する機能の詳細については、database data の管理、AI agents と workflows、Squid storage bucket connector、API connectorの documentation を参照してください。

お探しの feature が見つかりませんか？project についてのサポートは、お問い合わせください！