Object/Trait

io.scalajs.nodejs.path

Path

Related Docs: trait Path | package path

Permalink

object Path extends Object with Path

Path Singleton

Annotations
@native() @JSImport( "path" , JSImport.Namespace )
Linear Supertypes
Path, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Path
  2. Path
  3. Object
  4. Any
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def basename(path: String, ext: String = js.native): String

    Permalink

    Return the last portion of a path, similar to the Unix basename command.

    Return the last portion of a path, similar to the Unix basename command.

    path

    must be a string.

    ext

    optional, if given, must also be a string.

    returns

    the last portion of a path

    Definition Classes
    Path
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def delimiter: String

    Permalink

    The platform-specific path delimiter, ';' or ':'.

    The platform-specific path delimiter, ';' or ':'.

    Definition Classes
    Path
  8. def dirname(path: String): String

    Permalink

    Return the directory name of a path, similar to the Unix dirname command.

    Return the directory name of a path, similar to the Unix dirname command.

    path

    must be a string.

    returns

    the directory name of a path

    Definition Classes
    Path
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def extname(path: String): String

    Permalink

    Return the extension of the path, from the last '.' to end of string in the last portion of the path.

    Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.

    path

    must be a string.

    returns

    the extension of the path (e.g. ".jpg")

    Definition Classes
    Path
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def format(pathObject: PathObject): String

    Permalink

    Returns a path string from an object.

    Returns a path string from an object. This is the opposite of path.parse. If pathObject has dir and base properties, the returned string will be a concatenation of the dir property, the platform-dependent path separator, and the base property. If the dir property is not supplied, the root property will be used as the dir property. However, it will be assumed that the root property already ends with the platform-dependent path separator. In this case, the returned string will be the concatenation of the root property and the base property. If both the dir and the root properties are not supplied, then the returned string will be the contents of the base property. If the base property is not supplied, a concatenation of the name property and the ext property will be used as the base property.

    pathObject

    the given path object

    returns

    a path string from an object

    Definition Classes
    Path
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. def isAbsolute(path: String): Boolean

    Permalink

    Determines whether path is an absolute path.

    Determines whether path is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.

    path

    must be a string.

    returns

    true, if the path is an absolute path

    Definition Classes
    Path
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  20. def join(path1: String, path2: String*): String

    Permalink

    Join all arguments together and normalize the resulting path.

    Join all arguments together and normalize the resulting path.

    path1

    the first portion of the path

    path2

    All arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    returns

    a composite path

    Definition Classes
    Path
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def normalize(path: String): String

    Permalink

    Normalize a path, taking care of '..' and '.' parts.

    Normalize a path, taking care of '..' and '.' parts. path must be a string. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

    path

    the path to be normalized

    returns

    the normalized path

    Definition Classes
    Path
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def parse(path: String): PathObject

    Permalink

    Returns an object from a path.

    Returns an object from a path.

    path

    must be a string.

    returns

    an object from a path.

    Definition Classes
    Path
  26. def posix: Path

    Permalink

    Provide access to aforementioned path methods but always interact in a posix compatible way.

    Provide access to aforementioned path methods but always interact in a posix compatible way.

    Definition Classes
    Path
  27. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  28. def relative(from: String, to: String): String

    Permalink

    Solve the relative path from from to to.

    Solve the relative path from from to to.

    At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve, which means we see that:

    path.resolve(from, path.relative(from, to)) == path.resolve(to)
    from

    must be a string.

    to

    must be a string.

    returns

    the relative path

    Definition Classes
    Path
  29. def resolve(args: String*): String

    Permalink

    Resolves to to an absolute path.

    Resolves to to an absolute path. If to isn't already absolute from arguments are prepended in right to left order, until an absolute path is found. If after using all from paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. Empty string from arguments are ignored.

    args

    All arguments must be strings.

    returns

    the absolute path

    Definition Classes
    Path
    Example:
    1. path.resolve([from ...], to)
  30. def sep: String

    Permalink

    The platform-specific file separator, '\\' or '/'.

    The platform-specific file separator, '\\' or '/'.

    Definition Classes
    Path
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def win32: Path

    Permalink

    Provide access to aforementioned path methods but always interact in a win32 compatible way.

    Provide access to aforementioned path methods but always interact in a win32 compatible way.

    Definition Classes
    Path

Inherited from Path

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped