siteKiosk.fileSystem

Index

Methods

copy createDirectory delete enumerate exists getDescription getFileIcon isDirectory isFile move readFile readTextFile writeFile writeTextFile

Methods

copy

copy(from: string, dest: string): Promise<any>
Copies a file specified by its path to a destination path.
Parameters
- from: string
  
  The source path.
- dest: string
  
  The destination path.
Returns Promise<any>

createDirectory

createDirectory(path: string): Promise<any>
Creates a directory.
Parameters
- path: string
  
  The path to be created.
Returns Promise<any>

delete

delete(path: string, recursive: boolean): Promise<any>
Deletes a file by its path.
Parameters
- path: string
  
  The path.
- recursive: boolean
  
  Whether to delete recursively.
Returns Promise<any>

enumerate

enumerate(path: string, searchPattern: string, searchInSubDirectories: boolean): Promise<FileDescription[]>
Enumerates files.
Parameters
- path: string
  
  The path to be searched for.
- searchPattern: string
  
  The search pattern.
- searchInSubDirectories: boolean
  
  Whether to include searching in sub directories.
Returns Promise<FileDescription[]>

exists

exists(path: string): boolean
Returns whether a given file or path exists.
Parameters
- path: string
  
  The path to be checked.
Returns boolean

getDescription

getDescription(path: string): Promise<null | FileDescription>
Returns the file description. Or null when the file entry does not exist.
Parameters
- path: string
  
  The path to be searched for.
Returns Promise<null | FileDescription>

getFileIcon

getFileIcon(fileEndingOrPath: string, size?: number): Promise<string>
Returns the file icon.

Returns
The base64 encoded icon or an empty string if no icon was found.
Parameters
- fileEndingOrPath: string
  
  The file ending or path.
- Optional size: number
  
  The size of the icon in pixels. Default is 64.
Returns Promise<string>

isDirectory

isDirectory(path: string): boolean
Returns whether the path reflects a directory.
Parameters
- path: string
  
  The path to be searched for.
Returns boolean

isFile

isFile(path: string): boolean
Returns whether the path reflects a file.
Parameters
- path: string
  
  The path to be searched for.
Returns boolean

move

move(from: string, dest: string): Promise<any>
Moves a file specified by its path to a destination path.
Parameters
- from: string
  
  The source path.
- dest: string
  
  The destination path.
Returns Promise<any>

readFile

readFile(filePath: string, offset?: number, count?: number): Promise<Uint8Array>
Returns the content of a file specified by its path and returns its content as a byte buffer.
Parameters
- filePath: string
  
  The file path.
- Optional offset: number
  
  Byte offset to start reading from.
- Optional count: number
  
  Count of bytes to read, when 0 is used the remaining content starting from the offset will be read.
Returns Promise<Uint8Array>

readTextFile

readTextFile(filePath: string): Promise<string>
Returns the content of a text file specified by its path.
Parameters
- filePath: string
  
  The file path.
Returns Promise<string>

writeFile

writeFile(filePath: string, contents: Uint8Array): Promise<any>
Writes content to file specified by its path.
Parameters
- filePath: string
  
  The file path.
- contents: Uint8Array
  
  The file contets.
Returns Promise<any>

writeTextFile

writeTextFile(filePath: string, contents: string): Promise<any>
Writes content to a text file specified by its path.
Parameters
- filePath: string
  
  The file path.
- contents: string
  
  The file contets.
Returns Promise<any>

siteKiosk.fileSystem

Index

Methods

Methods

copy

Parameters

from: string

dest: string

Returns Promise<any>

createDirectory

Parameters

path: string

Returns Promise<any>

delete

Parameters

path: string

recursive: boolean

Returns Promise<any>

enumerate

Parameters

path: string

searchPattern: string

searchInSubDirectories: boolean

Returns Promise<FileDescription[]>

exists

Parameters

path: string

Returns boolean

getDescription

Parameters

path: string

Returns Promise<null | FileDescription>

getFileIcon

Returns

Parameters

fileEndingOrPath: string

Optional size: number

Returns Promise<string>

isDirectory

Parameters

path: string

Returns boolean

isFile

Parameters

path: string

Returns boolean

move

Parameters

from: string

dest: string

Returns Promise<any>

readFile

Parameters

filePath: string

Optional offset: number

Optional count: number

Returns Promise<Uint8Array>

readTextFile

Parameters

filePath: string

Returns Promise<string>

writeFile

Parameters

filePath: string

contents: Uint8Array

Returns Promise<any>

writeTextFile

Parameters

filePath: string

contents: string

Returns Promise<any>

`Optional` size: number

`Optional` offset: number

`Optional` count: number