インストール

モジュールをインストールします

  1. npm install @wordpress/blob --save

API

createBlobURL

ファイルから blob URL を作成します。

パラメータ

  • file File: blob URL を作成するためのファイルです。

戻り値

  • string: blob URL です。

downloadBlob

ブラウザでファイル(例: テキストまたは読み取り可能なストリーム)をダウンロードします。小さいファイルサイズ(例: < 5 MB)のダウンロードに適しています。

使用例:

  1. const fileContent = JSON.stringify(
  2. {
  3. title: 'My Post',
  4. },
  5. null,
  6. 2
  7. );
  8. const filename = 'file.json';
  9. downloadBlob( filename, fileContent, 'application/json' );

パラメータ

  • filename string: ファイル名です。
  • content BlobPart: ファイルの内容 (BufferSource | Blob | string) です。
  • contentType string: (オプション)ファイルの MIME タイプです。デフォルトは '' です。

getBlobByURL

blob URL に基づいてファイルを取得します。ファイルは createBlobURL によって作成され、revokeBlobURL によって削除されていない必要があります。そうでない場合は undefined を返します。

パラメータ

  • url string: blob URL です。

戻り値

  • File | undefined: blob URL のファイルです。

getBlobTypeByURL

URL に基づいて blob タイプを取得します。ファイルは createBlobURL によって作成され、revokeBlobURL によって削除されていない必要があります。そうでない場合は undefined を返します。

パラメータ

  • url string: blob URL です。

戻り値

  • string | undefined: blob タイプです。

isBlobURL

URL が blob URL かどうかを確認します。

パラメータ

  • url string | undefined: URL です。

戻り値

  • boolean: この URL は blob URL ですか?

revokeBlobURL

メモリからリソースとファイルキャッシュを削除します。

パラメータ

  • url string: blob URL です。

このパッケージへの貢献

これはグーテンベルクプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやグーテンベルク全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。