Bruce Pascoe at 03:22, 21 August 2017

2017-08-21T03:22:44Z

Bruce Pascoe: FS.fullPath() API page

2017-08-17T17:34:35Z

FS.fullPath() API page

New page

{{DISPLAYTITLE:FS.fullPath()}}

The '''<tt>FS.fullPath()</tt>''' function computes the canonical [[SphereFS]] pathname for a specified relative path and base directory.

===== Usage =====

''canon_path'' = '''FS.fullPath'''(''file_or_dir_name''[, ''base_path'']);

__TOC__

== API Information ==

=== Description ===

'''<tt>FS.fullPath()</tt>''' returns the complete, canonical SphereFS pathname for a given file or directory. If the path to be resolved already includes a SphereFS prefix such as <tt>@/</tt> or <tt>~/</tt>, then Sphere simply canonicalizes it (by removing any relative components); otherwise the path itself is considered relative and will be rebased before canonicalization. This allows you to get the full pathname of a file or directory given only its name and a known base directory, which can be useful in libraries.

=== Parameters ===

:{| class="wikitable"
!Name
!Type
!Default Value
!Description
|-
|''<tt>file_or_dir_name</tt>''
|style="text-align: center;"|''string''
|''n/a (Required)''
|The name of a file or directory. May include path components. It doesn't need to actually exist.
|-
|''<tt>base_path</tt>''
|style="text-align: center;"|''string''
|<tt>"@/"</tt>
|Specifies the base directory onto which relative paths will be rebased.
|}

=== Return Value ===

The full SphereFS pathname of the specified file or directory.

== See Also ==

<tt>
* [[API:FS.relativePath|FS.relativePath()]]
</tt>

[[Category:Sphere 2 API]]

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:FS.fullPath()}}
-The '''<tt>FS.fullPath()</tt>''' function computes the canonical [[SphereFS]] pathname for a specified relative path and base directory.
+The '''<tt>FS.fullPath()</tt>''' [[API:Functions|Core API]] function computes the canonical [[SphereFS]] pathname for a specified relative path and base directory.
 ===== Usage =====

API:FS.fullPath - Revision history

Bruce Pascoe at 03:22, 21 August 2017

Bruce Pascoe: FS.fullPath() API page