Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface System

Hierarchy

  • System

Index

Properties

Methods

Properties

args

args: string[]

newLine

newLine: string

useCaseSensitiveFileNames

useCaseSensitiveFileNames: boolean

Methods

Optional base64decode

  • base64decode(input: string): string

  • Parameters

    • input: string

    Returns string

Optional base64encode

  • base64encode(input: string): string

  • Parameters

    • input: string

    Returns string

Optional clearScreen

  • clearScreen(): void

  • Returns void

Optional clearTimeout

  • clearTimeout(timeoutId: any): void

  • Parameters

    • timeoutId: any

    Returns void

createDirectory

  • createDirectory(path: string): void

  • Parameters

    • path: string

    Returns void

Optional createHash

  • createHash(data: string): string

Optional createSHA256Hash

  • createSHA256Hash(data: string): string

  • This must be cryptographically secure. Only implement this method using crypto.createHash("sha256").

    Parameters

    • data: string

    Returns string

Optional deleteFile

  • deleteFile(path: string): void

  • Parameters

    • path: string

    Returns void

directoryExists

  • directoryExists(path: string): boolean

  • Parameters

    • path: string

    Returns boolean

exit

  • exit(exitCode?: number): void

  • Parameters

    • Optional exitCode: number

    Returns void

fileExists

  • fileExists(path: string): boolean

  • Parameters

    • path: string

    Returns boolean

getCurrentDirectory

  • getCurrentDirectory(): string

  • Returns string

getDirectories

  • getDirectories(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

getExecutingFilePath

  • getExecutingFilePath(): string

  • Returns string

Optional getFileSize

  • getFileSize(path: string): number

  • Parameters

    • path: string

    Returns number

Optional getMemoryUsage

  • getMemoryUsage(): number

  • Returns number

Optional getModifiedTime

  • getModifiedTime(path: string): Date

  • Parameters

    • path: string

    Returns Date

readDirectory

  • readDirectory(path: string, extensions?: readonly string[], exclude?: readonly string[], include?: readonly string[], depth?: number): string[]

  • Parameters

    • path: string
    • Optional extensions: readonly string[]
    • Optional exclude: readonly string[]
    • Optional include: readonly string[]
    • Optional depth: number

    Returns string[]

readFile

  • readFile(path: string, encoding?: string): string

  • Parameters

    • path: string
    • Optional encoding: string

    Returns string

Optional realpath

  • realpath(path: string): string

  • Parameters

    • path: string

    Returns string

resolvePath

  • resolvePath(path: string): string

  • Parameters

    • path: string

    Returns string

Optional setModifiedTime

  • setModifiedTime(path: string, time: Date): void

  • Parameters

    • path: string
    • time: Date

    Returns void

Optional setTimeout

  • setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): any

  • Parameters

    • callback: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns any

Optional watchDirectory

Optional watchFile

  • pollinginterval
    • this parameter is used in polling-based watchers and ignored in watchers that use native OS file watching

    Parameters

    Returns FileWatcher

write

  • write(s: string): void

  • Parameters

    • s: string

    Returns void

writeFile

  • writeFile(path: string, data: string, writeByteOrderMark?: boolean): void

  • Parameters

    • path: string
    • data: string
    • Optional writeByteOrderMark: boolean

    Returns void

Optional writeOutputIsTTY

  • writeOutputIsTTY(): boolean

  • Returns boolean

Generated using TypeDoc