OldAPI/file/ProposalK

From CommonJS Spec Wiki
< OldAPI‎ | file
Jump to: navigation, search
/**
*/

/*** File
    - :isa:`io#Io`
*/

/*** Stat
    - :isa:`Object`
    a representation of a file's metadata including permissions,
    ownership, time stamps, and other traits.
*/

/*** Dir
*/

/**** iter
*/

/*** glob
    returns a `List` of file names for a given "glob" expression
    that may contain patterns:

      ===  ======================================================
      ?    matches any single character
  
      *    matches any pattern of characters
  
      **   matches any pattern of characters
           in the file names of a depth first traversal
           starting with the file names and directories
           that start with the file name characters before ``**``
           and ending with the file name characters after ``**``
      ===  ======================================================
  
*/

/*** globIter
    returns an iteration of file names for a given "glob" expression
    that may contain patterns according to those documented
    in `glob`
*/

/*** separator
    The path separator for the platform's file systems.
*/

/*** resolve
    returns the real, absolute, fully-qualified path arrived
    at from a ``base`` path following an relative ``rel`` path.
    When no ``base`` is provided, resolves the ``rel`` path
    relative to the current working directory.

    - accepts ``rel``
    - accepts an optional ``base``

*/

/*** relative
    returns the relative path between two fully-qualifed paths.
*/

/*** baseName
*/

/*** dirName
*/