Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShareFolderHost

A host for sharing a folder.

Hierarchy

  • EventEmitter
    • ShareFolderHost

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _server

_server: Server | Server

options

options: ShareFolderHostOptions

The options for the host.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

isRunning

  • get isRunning(): boolean

  • Gets if the host is currently running or not.

    Returns boolean

port

  • get port(): number

  • Gets the TCP port for the host.

    Returns number

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Private createInstance

  • createInstance(): Promise<Express.Express>

  • Returns Promise<Express.Express>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Private setupEndpoints

  • setupEndpoints(app: Express.Express, rootDir: string): Promise<void>

  • Parameters

    • app: Express.Express
    • rootDir: string

    Returns Promise<void>

start

  • start(): Promise<boolean>

  • Starts the host.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

stop

  • stop(): Promise<boolean>

  • Stops the host.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc