[go: up one dir, main page]

locator

File system utility.
https://github.com/fal-works/locator/

To install, run:

haxelib install locator 0.5.0 

See using Haxelib in Haxelib documentation for more information.

README.md

locator

File system utility for Haxe.

Requires Haxe 4. Only for sys targets.

(Tested with: Haxe 4.2.5, eval/hl. Some methods are not available on java).

Types

Types based on String

  • PathString: Path of file/directory. Underlying type of FilePath and DirectoryPath.
  • FilePath: File path. The actual file does not necessarily have to exist.
  • FileRef: Represents a file that actually exists.
  • DirectoryPath: Directory path. The actual directory does not necessarily have to exist.
  • DirectoryRef: Represents a directory that actually exists.

The path is automatically converted to absolute when creating any value of the types above.

Other types

  • FileList: Array of FileRefs.
  • DirectoryList: Array of DirectoryRefs.
  • FileOrDirectoryPath: Enum, either FilePath or DirectoryPath.
  • FileOrDirectoryRef: Enum, either FileRef or DirectoryRef.
  • FileOrDirectoryList: Array of FileOrDirectoryRef.

Compilation flags

flagdescription
locator_validation_disableSkips validation of file/directory paths.

Dependencies

See also: FAL Haxe libraries

Contributors
fal-works
Version
0.5.0
Published
3 years ago
Dependencies
License
Apache

All libraries are free

Every month, more than a thousand developers use Haxelib to find, share, and reuse code — and assemble it in powerful new ways. Enjoy Haxe; It is great!

Explore Haxe

Haxe Manual

Haxe Code Cookbook

Haxe API documentation

You can try Haxe in the browser! try.haxe.org

Join us on GitHub!

Haxe is being developed on GitHub. Feel free to contribute or report issues to our projects.

Haxe on GitHub