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

API リファレンス

Blocklet Uploader パッケージの API リファレンスへようこそ。このセクションでは、フロントエンドとバックエンドの両ライブラリでエクスポートされるすべてのコンポーネント、関数、プロップ、および設定オプションに関する包括的な詳細を提供します。これは、詳細な技術情報を得るための頼りになるリソースです。

アップローダーは、2つの主要なパッケージに分かれています:

  • @blocklet/uploader: アプリケーションのフロントエンド用の柔軟な React コンポーネント。
  • @blocklet/uploader-server: バックエンドでファイルアップロードを処理するための Express ミドルウェアのセット。

これらはシームレスに連携するように設計されていますが、@blocklet/uploader は Tus の再開可能なアップロードプロトコルをサポートする任意のバックエンドで使用できることに注意してください。@blocklet/uploader-server は、Blocklet 内でアップロードロジックを処理するための強力で事前設定されたソリューションを提供しますが、その使用はオプションです。

以下のパッケージを選択して、詳細な API ドキュメントをご覧ください。

これらのパッケージがどのように構築され、他のシステムとどのように統合されるかについて、より高いレベルの理解が必要な場合は、コンセプト セクションをご覧ください。