メインコンテンツへスキップ

APIリファレンス

@blocklet/meta ライブラリは、blocklet.yml メタデータとプログラムで対話するための包括的なユーティリティ関数スイートを提供します。これらのヘルパーは、解析、検証、データ操作、セキュリティ操作などの一般的なタスクを効率化します。開発ツール、カスタムBlockletランタイム、

@blocklet/meta ライブラリは、blocklet.yml メタデータとプログラムで対話するための包括的なユーティリティ関数スイートを提供します。これらのヘルパーは、解析、検証、データ操作、セキュリティ操作などの一般的なタスクを効率化します。開発ツール、カスタムBlockletランタイム、またはBlockletエコシステムと対話するアプリケーションを構築している場合でも、これらのAPIは必要な構成要素を提供します。

このセクションは、エクスポートされたすべての関数について、そのコア機能ごとにグループ化された詳細なリファレンスとして機能します。これらの関数が操作するメタデータ構造を完全に理解するには、Blocklet仕様 (blocklet.yml) を参照してください。

以下のカテゴリを調べて、必要な特定の関数を見つけてください。各セクションでは、詳細な説明、パラメータ、使用例が提供されており、迅速に開始するのに役立ちます。

解析と検証

`blocklet.yml` ファイルの読み取り、解析、検証のための関数。`parse`、`validateMeta`、`fixAndValidateService`、その他の検証ヘルパーが含まれます。

メタデータヘルパー

リモートURLからBlockletメタデータを取得し、処理するためのユーティリティ。`getBlockletMetaByUrl` と `getSourceUrlsFromConfig` が含まれます。

コンポーネントと状態のユーティリティ

コンポーネントツリーの走査、特定のコンポーネントの検索、情報の抽出など、Blocklet状態オブジェクトを操作するためのヘルパー関数のコレクション。

DIDとウォレットのユーティリティ

Blockletコンテキスト内でDIDとウォレットを処理するための関数。Blocklet固有のDIDの作成、ウォレットの生成、ユーザー情報の抽出などが含まれます。

セキュリティユーティリティ

応答への署名、署名の検証、メタデータのマルチシグネチャ検証の管理など、暗号化操作のための関数。

ナビゲーションユーティリティ

Blockletのメタデータと状態から `navigation` プロパティを解析・処理し、動的なユーザーインターフェースを構築するための関数。

URLとパスのユーティリティ

URLフレンドリーな文字列の作成やURLパスの検証に役立つヘルパー。クリーンで有効なルートの生成に便利です。

ファイルユーティリティ

ファイルシステム上で `blocklet.yml` ファイルを読み書き、検索するための低レベル関数、およびファイル検証用のカスタムJoi拡張。

その他のユーティリティ

コミュニケーションチャネルヘルパーやアイデンティティアイコン(Blockies)の生成など、その他の便利なユーティリティのコレクション。