UIZE JavaScript Framework

MODULES Uize.Services.FileSystem

SEARCHEXAMPLESSOURCETO DODEPSTEST

1. Introduction

The Uize.Services.FileSystem module defines a class for a file system service.

DEVELOPERS: Chris van Rensburg & Ben Ilegbodu

1.1. Examples

There are no dedicated showcase example pages for the Uize.Services.FileSystem module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Services.FileSystem module...

SEARCH

1.2. Implementation Info

The Uize.Services.FileSystem module defines the Uize.Services.FileSystem class, which is a subclass of Uize.Service.

INHERITANCE CHAIN

Uize.Class −> Uize.Service −> Uize.Services.FileSystem

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

INSTANCE METHODS

copyFile | deleteFile | deleteFolder | fileExists | folderExists | getFiles | getFolders | getModifiedDate | init | makeFolder | moveFile | pathExists | readFile | writeFile

1.2.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

valueOf

STATIC PROPERTIES

Uize.Services.FileSystem.moduleName | Uize.Services.FileSystem.nonInheritableStatics

1.2.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

fire | get | is | isMet | kill | met | onChange | once | set | toggle | unmet | unwire | whenever | wire

STATE PROPERTIES

adapter | initialized

STATIC METHODS

Uize.Services.FileSystem.alphastructor | Uize.Services.FileSystem.declare | Uize.Services.FileSystem.doMy | Uize.Services.FileSystem.dualContextMethods | Uize.Services.FileSystem.dualContextProperties | Uize.Services.FileSystem.fire | Uize.Services.FileSystem.get | Uize.Services.FileSystem.instanceMethods | Uize.Services.FileSystem.instanceProperties | Uize.Services.FileSystem.mixins | Uize.Services.FileSystem.omegastructor | Uize.Services.FileSystem.serviceMethods | Uize.Services.FileSystem.set | Uize.Services.FileSystem.singleton | Uize.Services.FileSystem.stateProperties | Uize.Services.FileSystem.staticMethods | Uize.Services.FileSystem.staticProperties | Uize.Services.FileSystem.subclass | Uize.Services.FileSystem.toggle | Uize.Services.FileSystem.unwire | Uize.Services.FileSystem.wire

STATIC PROPERTIES

Uize.Services.FileSystem.pathToResources

1.2.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.2.5. Unit Tests

The Uize.Services.FileSystem module is unit tested by the Uize.Test.Uize.Services.FileSystem test module.

2. Instance Methods

2.1. copyFile

.

SYNTAX

fileSystemInstance.copyFile (paramsOBJ);

2.1.1. Params

2.1.1.1. path

.

2.1.1.2. targetPath

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.2. deleteFile

.

SYNTAX

fileSystemInstance.deleteFile (paramsOBJ);

2.2.1. Params

2.2.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.3. deleteFolder

.

SYNTAX

fileSystemInstance.deleteFolder (paramsOBJ);

2.3.1. Params

2.3.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.4. fileExists

.

SYNTAX

fileExistsBOOL = fileSystemInstance.fileExists (paramsOBJ);

2.4.1. Params

2.4.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.5. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.6. folderExists

.

SYNTAX

folderExistsBOOL = fileSystemInstance.folderExists (paramsOBJ);

2.6.1. Params

2.6.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.7. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.8. getFiles

.

SYNTAX

filePathsARRAY = fileSystemInstance.getFiles (paramsOBJ);

2.8.1. Params

2.8.1.1. path

.

2.8.1.2. pathMatcher

.

2.8.1.3. pathTransformer

.

2.8.1.4. recursive

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.9. getFolders

.

SYNTAX

filePathsARRAY = fileSystemInstance.getFolders (paramsOBJ);

2.9.1. Params

2.9.1.1. path

.

2.9.1.2. pathMatcher

.

2.9.1.3. pathTransformer

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.10. getModifiedDate

.

SYNTAX

modifiedDateOBJ = fileSystemInstance.getModifiedDate (paramsOBJ);

2.10.1. Params

2.10.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.11. init

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.12. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.13. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.14. kill

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.15. makeFolder

.

SYNTAX

fileSystemInstance.makeFolder (paramsOBJ);

2.15.1. Params

2.15.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.16. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.17. moveFile

.

SYNTAX

fileContentsSTR = fileSystemInstance.moveFile (paramsOBJ);

2.17.1. Params

2.17.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.18. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.19. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.20. pathExists

.

SYNTAX

pathExistsBOOL = fileSystemInstance.pathExists (paramsOBJ);

2.20.1. Params

2.20.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.21. readFile

.

SYNTAX

fileContentsSTR = fileSystemInstance.readFile (paramsOBJ);

2.21.1. Params

2.21.1.1. path

.

IMPLEMENTATION INFO

this feature was introduced in this module

2.22. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.23. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.24. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.25. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.26. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

2.27. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.28. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.29. writeFile

.

SYNTAX

fileSystemInstance.writeFile (paramsOBJ);

2.29.1. Params

2.29.1.1. path

.

2.29.1.2. contents

.

IMPLEMENTATION INFO

this feature was introduced in this module

3. State Properties

3.1. adapter

Inherited from Uize.Service.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service)

3.2. initialized

Inherited from Uize.Service.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service)

4. Static Methods

4.1. Uize.Services.FileSystem.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.2. Uize.Services.FileSystem.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.3. Uize.Services.FileSystem.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.4. Uize.Services.FileSystem.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.5. Uize.Services.FileSystem.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.6. Uize.Services.FileSystem.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.7. Uize.Services.FileSystem.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.8. Uize.Services.FileSystem.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.9. Uize.Services.FileSystem.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.10. Uize.Services.FileSystem.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.11. Uize.Services.FileSystem.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.12. Uize.Services.FileSystem.serviceMethods

Inherited from Uize.Service.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service)
this static feature is inherited by subclasses

4.13. Uize.Services.FileSystem.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.14. Uize.Services.FileSystem.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.15. Uize.Services.FileSystem.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.16. Uize.Services.FileSystem.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.17. Uize.Services.FileSystem.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.18. Uize.Services.FileSystem.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.19. Uize.Services.FileSystem.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.20. Uize.Services.FileSystem.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

4.21. Uize.Services.FileSystem.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5. Static Properties

5.1. Uize.Services.FileSystem.moduleName

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.2. Uize.Services.FileSystem.nonInheritableStatics

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is not inherited by subclasses

5.3. Uize.Services.FileSystem.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses