APIリファレンス(JavaScript)

baasatrakuza > DataQuery > headWithRelation

DataQuery.headWithRelation() method

オブジェクトデータを検索して、最初の1件を関連オブジェクト付きで返します。

Signature:

headWithRelation(treeCount?: number): Promise<Data | null>;

Parameters

ParameterTypeDescription
treeCountnumber関連オブジェクトの取得階層数

Returns:

Promise<Data | null>

オブジェクトデータまたはnull

Remarks

TIP

検索条件、ソート条件、取得範囲(offset, limit)を指定することができます。

WARNING

DataClient.getWithRelation()と異なり、データが見つからない場合はnullを返します。