Bruce Pascoe at 18:37, 18 August 2017

2017-08-18T18:37:49Z

Bruce Pascoe: Add FS.relativePath() page

2017-08-18T18:32:23Z

Add FS.relativePath() page

New page

{{DISPLAYTITLE:FS.relativePath()}}

The '''<tt>FS.relativePath()</tt>''' function computes an abbreviated path for a specified file or directory.

===== Usage =====

''rel_path'' = '''FS.relativePath'''(''file_or_dir_name''[, ''base_dir_name'']);

__TOC__

== API Information ==

=== Description ===

'''<tt>FS.relativePath()</tt>''' takes a file or directory name and returns an abbreviated version relative to a specified base directory. This is useful when logging or displaying filenames where the full path might be too verbose.

If the [[SphereFS]] prefixes of the (canonicalized) input path and base directory differ, then the full pathname is returned without attempting to abbreviate it. This ensures that one can always recover the original path by doing:

rel_path = FS.relativePath(path, base_dir);
/* ... */
path = FS.fullPath(rel_path, base_dir);

=== Parameters ===

:{| class="wikitable"
!Name
!Type
!Default
!Description
|-
|''<tt>file_or_dir_name</tt>''
|style="text-align: center;"|''string''
|
|The name of a file or directory, resolved per SphereFS rules (relative to <tt>@/</tt>). It doesn't need to actually exist.
|-
|''<tt>base_dir_name</tt>''
|style="text-align: center;"|''string''
|
|Specifies the base directory for the relative path.
|}

=== Return Value ===

An abbreviated version of <tt>''file_or_dir_name''</tt> relative to the specified base directory.

== See Also ==

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

[[Category:Sphere 2 API]]

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:FS.relativePath()}}
-The '''<tt>FS.relativePath()</tt>''' function computes an abbreviated path for a specified file or directory.
+The '''<tt>FS.relativePath()</tt>''' [[API:Functions|Core API]] function computes an abbreviated path for a specified file or directory.
 ===== Usage =====

API:FS.relativePath - Revision history

Bruce Pascoe at 18:37, 18 August 2017

Bruce Pascoe: Add FS.relativePath() page