File

File インターフェイスは、ファイルについての情報を提供したり、ウェブページ内の JavaScript でその内容にアクセスできるようにしたりします。

File オブジェクトは一般的に <input> 要素を使用してユーザがファイルを選択した結果として返された FileList オブジェクトや、ドラッグアンドドロップ操作の DataTransfer オブジェクト、 HTMLCanvasElement の mozGetAsFile() API から情報を取得します。 Gecko では、特権コードはユーザーによる操作なしにローカルファイルを表す File オブジェクトを作ることができます (詳しくは Implementation notes を参照してください)。

File オブジェクトは特別な種類の Blob オブジェクトであり、 Blob が利用できる場面ではどこでも利用できます。特に、 FileReader, URL.createObjectURL(), createImageBitmap(), XMLHttpRequest.send() は Blob と File の両方を受け付けることができます。

詳しい情報や例は、ウェブアプリケーションからのファイルの使用を参照してください。

  <div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 11.666666666666666%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 70" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/ja/docs/Web/API/Blob" target="_top"><rect x="1" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text  x="38.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Blob</text></a><polyline points="76,25  86,20  86,30  76,25" stroke="#D4DDE4" fill="none"/><line x1="86" y1="25" x2="116" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/ja/docs/Web/API/File" target="_top"><rect x="116" y="1" width="75" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text  x="153.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">File</text></a></svg></div>

  a:hover text { fill: #0095DD; pointer-events: all;}

コンストラクター

File()

新しく構築された File オブジェクトを返します。

プロパティ

File.lastModified 読取専用

ファイルの最終更新時刻を、 UNIX 時刻 (1970年1月1日0:00からの経過ミリ秒数) を返します。

File.lastModifiedDate 読取専用

File オブジェクトが参照しているファイルの最終更新時刻の Date オブジェクトを返します。

File.name 読取専用

File オブジェクトが参照しているファイルのファイル名を返します。

File.webkitRelativePath 読取専用

File オブジェクトが関連付けられている URL のパスを返します。

File は Blob インターフェイスを実装していますので、以下のプロパティも持っています。

File.size 読取専用

ファイルのサイズをバイト単位で返します。

File.type 読取専用

ファイルの MIME タイプを返します。

メソッド

File インターフェイスはメソッドを定義していませんが、 Blob インターフェイスのメソッドを継承しています。

Blob.slice([start[, end[, contentType]]])

元の Blob の中でバイト単位で特定の範囲のデータを含む新しい Blob オブジェクトを返します。

仕様書

ブラウザーの対応

このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 https://github.com/mdn/browser-compat-data をチェックアウトしてプルリクエストを送信してください。

実装ノート

• Gecko ではクロームコード内でこの API を使用できます。詳細は クロームコードにおける DOM File API の使用を参照してください。クロームコード、 JSM、 ブートストラップスコープから利用するためには Cu.importGlobalProperties(['File']); を使用してインポートする必要があります。
• Gecko 6.0 (Firefox 6.0 / Thunderbird 6.0 / SeaMonkey 2.3) からは、(拡張機能のような) 特権コードは、参照するファイルを特定するために DOM の File コンストラクターに nsIFile オブジェクトを渡すことができます。
• Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5) からは、 nsIDOMFile オブジェクトから直接インスタンス化する代わりに、 new File を使用して、 XPCOM コンポーネントコードから File オブジェクトを生成できます。コンストラクタでは Blob と対照的に、第2引数にファイル名が必要になります。ファイル名は任意の文字列とすることができます。

  new File(
    Array parts,
    String filename, 
    BlobPropertyBag properties
  );

• 次の非標準のプロパティは Gecko 7 (Firefox 7.0 / Thunderbird 7.0 / SeaMonkey 2.4) で削除されました。 File.fileName, File.fileSize, File.getAsBinary(), File.getAsDataURL(), File.getAsText(string encoding) (バグ 661876)。代わりに標準プロパティ File.name, Blob.size, FileReader を使用してください。

関連情報

• ウェブアプリケーションからのファイルの使用
• FileReader
• chrome コードにおける DOM File API の使用 (Firefox アドオンのような Gecko で実行される特権コード向け)