Home Manual Reference Source Test 
import ProjectConfig from 'atscm/src/config/ProjectConfig.js'
public class | source

ProjectConfig

Extends:

Config → ProjectConfig

The current project's configuration, with overrides (through ATSCM_PROJECT__ env vars) already handled.

Test:

Static Member Summary

Static Public Members
public static get

The atvise server's host. Can be overridden with the ATSCM_PROJECT__HOST env variable.
public static get

A regular expression matching all ignored nodes.
public static get

The login to use.
public static get

The atvise server ports to use.
public static get

A regular expression matching all source nodes.
public static get

The connection timeout, in milliseconds.
Static Private Members
private static
private static

Static Method Summary

Static Public Methods
public static

Returns true for all external (not in Atviseproject.nodes or ignored by Atviseproject.ignoreNodes).
Static Private Methods
private static

_env(name: string): *: string | undefined

Return the project configuration override for the given name if available.

Static Public Members

public static get host: string source

The atvise server's host. Can be overridden with the ATSCM_PROJECT__HOST env variable.

public static get ignoredNodesRegExp: * source

A regular expression matching all ignored nodes.

public static get login: Object source

The login to use. Return false if no login is required (default).

Properties:

NameTypeAttributeDescription
username string

The username to log in with. Can be overridden with the ATSCM_PROJECT__LOGIN__USERNAME env variable.
password string

The password to log in with. Can be overridden with the ATSCM_PROJECT__LOGIN__PASSWORD env variable.

public static get port: Object source

The atvise server ports to use.

Properties:

NameTypeAttributeDescription
opc number

The OPC-UA port the atvise server runs on. Can be overridden with the ATSCM_PROJECT__PORT__OPC env variable.
http number

The HTTP port the atvise server can be reached at. Can be overridden with the ATSCM_PROJECT__PORT__HTTP env variable.

public static get sourceNodeRegExp: * source

A regular expression matching all source nodes.

public static get timeout: number source

The connection timeout, in milliseconds. Can be overridden with the ATSCM_PROJECT__TIMEOUT env variable.

Static Private Members

private static _ignoredNodesRegExp: * source

private static _sourceNodesRegExp: * source

Static Public Methods

public static isExternal(id: string): boolean source

Returns true for all external (not in Atviseproject.nodes or ignored by Atviseproject.ignoreNodes).

Params:

NameTypeAttributeDescription
id string

The node id to check.

Return:

boolean

If the node is external.

Static Private Methods

private static _env(name: string): *: string | undefined source

Return the project configuration override for the given name if available.

Params:

NameTypeAttributeDescription
name string

The variable to return.

Return:

*