インストール
モジュールをインストールします
npm install @wordpress/blob --save
API
createBlobURL
ファイルから blob URL を作成します。
パラメータ
- file
File
: blob URL を作成するためのファイルです。
戻り値
downloadBlob
ブラウザでファイル(例: テキストまたは読み取り可能なストリーム)をダウンロードします。小さいファイルサイズ(例: < 5 MB)のダウンロードに適しています。
使用例:
const fileContent = JSON.stringify(
{
title: 'My Post',
},
null,
2
);
const filename = 'file.json';
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 です。
戻り値
getBlobTypeByURL
URL に基づいて blob タイプを取得します。ファイルは createBlobURL
によって作成され、revokeBlobURL
によって削除されていない必要があります。そうでない場合は undefined
を返します。
パラメータ
- url
string
: blob URL です。
戻り値
isBlobURL
URL が blob URL かどうかを確認します。
パラメータ
- url
string | undefined
: URL です。
戻り値
revokeBlobURL
メモリからリソースとファイルキャッシュを削除します。
パラメータ
このパッケージへの貢献
これはグーテンベルクプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。
このパッケージやグーテンベルク全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。