io.scalajs.dom.html.File.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dom-html_sjs0.6_2.11 Show documentation

DOM/HTML bindings for Scala.js

There is a newer version: 0.4.2

package io.scalajs.dom.html

import scala.scalajs.js

/**
  * The File interface provides information about files and allows JavaScript in a web page to access their content.
  *
  * File objects are generally retrieved from a FileList object returned as a result of a user selecting files using
  * the  element, from a drag and drop operation's DataTransfer object, or from the mozGetAsFile() API on an
  * HTMLCanvasElement. In Gecko, privileged code can create File objects representing any local file without user
  * interaction (see Gecko notes for more information.)
  *
  * A File object is a specific kind of a [[Blob]], and can be used in any context that a Blob can. In particular,
  * [[FileReader]], URL.createObjectURL(), createImageBitmap(), and XMLHttpRequest.send() accept both Blobs and Files.
  * @see https://developer.mozilla.org/en-US/docs/Web/API/File
  * @author [email protected]
  */
@js.native
class File(path: String) extends Blob(null) {

  /////////////////////////////////////////////////////////////////////////////////
  //      Properties
  /////////////////////////////////////////////////////////////////////////////////

  /**
    * Returns the name of the file referenced by the File object.
    */
  def name: String = js.native

  /**
    * Returns the last modified time of the file, in millisecond since the UNIX epoch (January 1st, 1970 at Midnight).
    */
  def lastModified: Double = js.native

  /**
    * Returns the last modified date of the file. Files without a known last modified date returns the current date.
    */
  def lastModifiedDate: js.Date = js.native

  /**
    * The File.webkitRelativePath is a read-only property that contains a DOMString with the path relative to the
    * directory selected when the webkitdirectory has been set on the  element.
    */
  def webkitRelativePath: File = js.native

}