Class Station

Hierarchy

Station

Index

Interfaces

Configs

Constructors

constructor

Properties

Methods

Object literals

configs

Constructors

constructor

new Station(name?: string, observedDimensions: Dimension | Array<Dimension>, configs?: DeepPartial<Configs>): Station

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Station/index.ts#L61
Parameters
- Default value name: string = ""
- observedDimensions: Dimension | Array<Dimension>
- Default value configs: DeepPartial<Configs> = {}
Returns Station

Properties

app

app: express.Application

id

id: number = 0

Private log

log: Logger = new Logger(Logger.LEVEL.INFO, 'Station Log')

maxAttempts

maxAttempts: number = 16

name

name: string

port

port: number = 9000

Private server

server: Server

webport

webport: number = 3000

Static _id

_id: number = 0

Methods

observe

observe(dimension: Dimension): void

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Station/index.ts#L221
Parameters
- dimension: Dimension
Returns void

restart

restart(): Promise<number>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Station/index.ts#L198
Restart Station server / API Resolves with the port number used

Returns Promise<number>

setLogLevel

setLogLevel(level: LEVEL): void

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Station/index.ts#L190
Parameters
- level: LEVEL
Returns void

stop

stop(): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Station/index.ts#L211
Stop the Station server / API

Returns Promise<void>

Private tryToListen

tryToListen(app: express.Application, startingPort: number): Promise<number>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Station/index.ts#L164
Try to listen to this.maxAttempts ports. Resolves with the port nunber used

Parameters
- app: express.Application
- startingPort: number
Returns Promise<number>

Object literals

configs

configs: object

disableUploads

disableUploads: false = false

loggingLevel

loggingLevel: INFO = Logger.LEVEL.INFO

requireAuth

requireAuth: true = true

Generated using TypeDoc