Hexabase TypeScript SDKを使ってデータストアのデータを取得する

Hexabase（ヘキサベース）は企業においても安心して利用できるBaaS（Backend as a Service）を提供しています。多くのBaaSがそうであるように、主にフロントエンド開発者に利用してもらいたいと考えています。そこで現在、TypeScript SDKの開発が進められています。

この記事ではHexabase TypeScript SDKのインストールと、データストアからデータを取得し、そのデータにある値を取得する方法を紹介します。

インストール

インストールはnpmやyarnを使って行います。

# npmの場合
npm install @hexabase/hexabase-js

# yarnの場合
yarn add @hexabase/hexabase-js

インポート

インポートすると、 HexabaseClient というオブジェクトが取得できます。

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

初期化

HexabaseClientを初期化します。

const client = new HexabaseClient();

認証

Hexabaseでは業務利用を想定しているため、利用する際に認証情報が必須になります。最初はメールアドレスとパスワードで認証し、その後はトークンを使ってGraphQLにアクセスします。 client を使って処理します。

初回の認証は次のようになります。emailとパスワード、またはトークンが必須です。

await client.login({email, password, token});

後はこの client に対して処理を行います。

データストアへのアクセス時に必要な情報について

データストアへアクセスする際には以下の情報が必要です。

• データストアID datastoreId
• プロジェクトID projectId

さらにデータ取得を行う際の情報（ページ数、取得件数など） params が指定できます。以下がアクセス例です。

const project = client.currentWorkspace.project(projectId);
const datastore = project.datastore(datastoreId);
const items = await datastore.items();
const item = items[0];

データを取得する

データを取得する際には get メソッドを使ってください。型を指定できます。

item.get('Title'); // as any
item.get<string>('Title'); // as string

デフォルト値を指定する

もし値がなかった時のために、デフォルト値を指定できます。

item.get<string>('Title', 'Hello'); // -> Titleの値がなかったらHello

指定できる型

Hexabaseで利用できる型は以下の通りです。

• string
  文字列
• number
  数値
• Date
  日付
• FileObject[]
  添付ファイル
• User[]
  ユーザー
• Item
  関連アイテム

まとめ

データストアはクラウドデータベースとして、様々な型をサポートしたテーブルが利用できます。ぜひ皆さんのWebアプリケーションで利用してください。Hexabase TypeScript SDKを使えば、VueやReactなどと連携したWebアプリを素早く開発できるようになります。

2023年05月現在絶賛開発を進めていますので、ぜひ試していただいてフィードバックいただければ嬉しいです！

hexabase/hexabase-js