SDKの初期化

HexabaseClientはHexabaseを操作する際の、ルートオブジェクトになります。

HexabaseClientのインポート

HexabaseClientは、 @hexabase/hexabase-jsからインポートします。

import { HexabaseClient }  from '@hexabase/hexabase-js';

HexabaseClientの初期化

HexabaseClientを初期化するには、 new 演算子を使います。これでHexabaseの利用準備が整います。

const client = new HexabaseClient();

初期化オプション

HexabaseClientの初期化時には、以下のパラメーターを指定できます。すべてオプションです。

オプション名	説明
env	環境名。省略時は本番環境の設定が適用されます。 dev を指定すると、ステージング環境の設定になります。
url	GraphQL APIのエンドポイントURLを指定します。
rest	REST APIのエンドポイントURLを指定します。
pubsub	PubSubのエンドポイントURLを指定します

ステージング環境でHexabseを利用する場合には、以下のように初期化します。

const client = new HexabaseClient({
    env: 'dev',
});

URLを細かくカスタマイズする場合には、以下のように初期化します。

const client = new HexabaseClient({
    env: 'dev', // ベースはステージング環境
    url: 'https://api.stg.hexabase.com/graphql', // GraphQLのエンドポイントだけカスタマイズ
});