Class BaseServerAbstract

Constructors

constructor

Properties

args argsVars configFileMode configPath cwd existsSync fps frameCount frameNr framesPattern hasArgHeight hasArgWidth height isDirectory isVerbose logLevel maxFps maxFrameCount maxHeight maxWidth mkdirpSync platform posixPathJoin progress projDir readUtf8Sync reportFileName rootPath serverName timeout toDeletePreviousVersion toGenFrames toTeleport unlinkSync url width writeFileSync

Methods

checkForValidFps checkForValidFrame exitServer generateReport getPageUrl getSetupVars getViewport handleError handleMessage parseArgumentsAsync prepareServer runServer start

Constructors

constructor

  • new BaseServer(serverName, args, platform, cwd, existsSync, isDirectory, unlinkSync, mkdirpSync, readUtf8Sync, writeFileSync, posixPathJoin): BaseServer

  • Parameters

    • serverName: string
    • args: string[]
    • platform: string
    • cwd: string
    • existsSync: ((fileName: string) => boolean)
        • (fileName): boolean

        • Parameters

          • fileName: string

          Returns boolean

    • isDirectory: ((fileName: string) => boolean)
        • (fileName): boolean

        • Parameters

          • fileName: string

          Returns boolean

    • unlinkSync: ((fileName: string) => void)
        • (fileName): void

        • Parameters

          • fileName: string

          Returns void

    • mkdirpSync: ((path: string) => void)
        • (path): void

        • Parameters

          • path: string

          Returns void

    • readUtf8Sync: ((fileName: string) => any)
        • (fileName): any

        • Parameters

          • fileName: string

          Returns any

    • writeFileSync: ((fileName: string, data: any) => void)
        • (fileName, data): void

        • Parameters

          • fileName: string
          • data: any

          Returns void

    • posixPathJoin: ((path1: string, path2: string) => string)
        • (path1, path2): string

        • Parameters

          • path1: string
          • path2: string

          Returns string

    Returns BaseServer

Properties

args

args: string[]

argsVars

argsVars: any

configFileMode

configFileMode: boolean = false

configPath

configPath: string = ''

cwd

cwd: string

existsSync

existsSync: ((fileName: string) => boolean)

fps

fps: number = 1

frameCount

frameCount: number = 0

frameNr

frameNr: number = 0

framesPattern

framesPattern: string = ''

hasArgHeight

hasArgHeight: boolean = false

hasArgWidth

hasArgWidth: boolean = false

height

height: uint = RelConsts.DEFAULT_HEIGHT

isDirectory

isDirectory: ((fileName: string) => boolean)

isVerbose

isVerbose: boolean = false

logLevel

logLevel: any = consts.LL_WARN

maxFps

maxFps: uint = OptsParser.DEFAULT_MAX_FPS

maxFrameCount

maxFrameCount: uint = OptsParser.DEFAULT_MAX_FRAME_COUNT

maxHeight

maxHeight: uint = OptsParser.DEFAULT_MAX_HEIGHT

maxWidth

maxWidth: uint = OptsParser.DEFAULT_MAX_WIDTH

mkdirpSync

mkdirpSync: ((path: string) => void)

platform

platform: string

posixPathJoin

posixPathJoin: ((path1: string, path2: string) => string)

progress

progress: uint = OptsParser.DEFAULT_PROGRESS

projDir

projDir: string = ''

readUtf8Sync

readUtf8Sync: ((fileName: string) => any)

reportFileName

reportFileName: string = OptsParser.DEFAULT_OUT_REPORT

rootPath

rootPath: string = ''

serverName

serverName: string

timeout

timeout: uint = 0

toDeletePreviousVersion

toDeletePreviousVersion: boolean = false

toGenFrames

toGenFrames: boolean = true

toTeleport

toTeleport: boolean = false

unlinkSync

unlinkSync: ((fileName: string) => void)

url

url: string = ''

width

width: uint = RelConsts.DEFAULT_WIDTH

writeFileSync

writeFileSync: ((fileName: string, data: any) => void)

Methods

checkForValidFps

  • checkForValidFps(): void

  • Returns void

checkForValidFrame

  • checkForValidFrame(frameNr, allowZero, errorMsg): void

  • Parameters

    • frameNr: uint
    • allowZero: boolean
    • errorMsg: string

    Returns void

exitServer

  • exitServer(_retValue?): void

  • Parameters

    • _retValue: number = 0

    Returns void

generateReport

  • generateReport(): void

  • Returns void

getPageUrl

  • getPageUrl(): string

  • Returns string

getSetupVars

  • getSetupVars(): string

  • Returns string

getViewport

  • getViewport(): {
        height: uint;
        width: uint;
    }

  • Returns {
        height: uint;
        width: uint;
    }

    • height: uint
    • width: uint

handleError

  • handleError(msg): void

  • Parameters

    • msg: string

    Returns void

handleMessage

  • handleMessage(msg, sendClientMsg, takeScreenshot): void

  • Parameters

    • msg: string
    • sendClientMsg: ((cmd: string, value?: string) => void)
        • (cmd, value?): void

        • Parameters

          • cmd: string
          • Optionalvalue: string

          Returns void

    • takeScreenshot: ((outFileName: string, onDone: (() => void)) => void)
        • (outFileName, onDone): void

        • Parameters

          • outFileName: string
          • onDone: (() => void)
              • (): void

              • Returns void

          Returns void

    Returns void

parseArgumentsAsync

  • parseArgumentsAsync(callback): void

  • Parse Arguments is async to later provide async config loading

    Parameters

    • callback: ((res: int) => void)
        • (res): void

        • Parameters

          • res: int

          Returns void

    Returns void

prepareServer

  • prepareServer(): void

  • Returns void

AbstractrunServer

  • runServer(): any

  • Returns any

start

  • start(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods