Class: UnionFileSystem

@nginstack/engine/lib/ufs/UnionFileSystem~ UnionFileSystem


new UnionFileSystem()

Representa a UnionFileSystem e provê uma API para acessar seus arquivos e diretórios.

Members


<static> FILTER_ALL :number

Não aplica nenhum filtro.

Type:
  • number

<static> FILTER_DIRS :number

Filtra pelos diretórios.

Type:
  • number

<static> FILTER_FILES :number

Filtra pelos arquivos.

Type:
  • number

Methods


<static> getInstance()

Obtém uma instância compartilhada desta classe.

Returns:
Type
UnionFileSystem

configureWithLocalSettings()

Configura a unionFS com as definições presentes no arquivo iengine.conf. Esta função deve ser utilizada apenas em scripts de inicialização do Engine.


exists(path)

Identifica se o caminho informado referência um arquivo ou diretório

Parameters:
Name Type Description
path string

Caminho a ser avaliado.

Returns:

True se existe.

Type
boolean

getFileOrigin(path)

Indica a origem do arquivo informado.

Parameters:
Name Type Description
path string

Caminho do arquivo.

Returns:

Retorna a origem do arquivo informado.

Type
string

getLastUpdateTimestamp(path)

Retorna o timeStamp da última modificação do arquivo.

Parameters:
Name Type Description
path string

Caminho do arquivo.

Returns:

TimeStamp da última modificação. Retornará undefined caso o arquivo não exista.

Type
number

isDirectory(path)

Identifica se o caminho informado referência um diretório.

Parameters:
Name Type Description
path string

Caminho do diretório.

Returns:

True se é um diretório.

Type
boolean

isFile(path)

Identifica se o caminho informado referência um arquivo.

Parameters:
Name Type Description
path string

Caminho do arquivo.

Returns:

True se é um arquivo.

Type
boolean

list(path [, entryFilter])

Retorna um array de strings com o nome dos conteúdos que compõem um diretório.

Parameters:
Name Type Argument Description
path string

Caminho do diretório.

entryFilter number <optional>

tipo de filtro aplicado na listagem. Opções: UnionFileSystem.FILTER_FILES, UnionFileSystem.FILTER_DIRS, UnionFileSystem.FILTER_ALL. Valor padrão: UnionFileSystem.FILTER_ALL

Returns:

Nome dos arquivos ou diretórios contidos no caminho informado.

Type
Array.<string>

readFileContent(path)

Lê o conteúdo de um arquivo da UnionFileSystem

Parameters:
Name Type Description
path string

Caminho do arquivo.

Returns:

Conteúdo do arquivo.

Type
string