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

Atviseproject

An atscm project's configuration.

Test:

Static Member Summary

Static Public Members
public static get

Server nodes atscm manages itself.
public static get

An array of editor related node ids.
public static get

An array of server related node ids.
public static get

The atvise-server's host. Defaults to localhost.
public static get

These nodes (and their subnodes, if any) will be ignored by atscm.
public static get

The login to use.
public static get

The atvise-server nodes that atscm should sync.
public static get

The atvise-server nodes to watch in the corresponding tasks.
public static get

The atvise-server ports to use.
public static get
this get was deprecated. Mapping source order nodes leads to inconsistent results in many cases.

If atvise builder sort order nodes should be stored.

 since 1.0.0
public static get

The connection timeout, in milliseconds.
public static get

The transformers to use in this project.
public static get

vcs: 'git' | 'svn'

The version control system to optimize tasks for.

 since 1.0.0

Static Method Summary

Static Public Methods
public static

Returns an object containing the properties to inspect.

Static Public Members

public static get AtscmRelatedNodes: NodeId[] source

Server nodes atscm manages itself. These include the serverscripts used during pull/push for example.

public static get EditorRelatedNodes: NodeId[] source

An array of editor related node ids. They should be ignored in a atscm project.

Test:

public static get ServerRelatedNodes: NodeId[] source

An array of server related node ids. They should be ignored in a atscm project as they are read-only.

Test:

public static get host: string source

The atvise-server's host. Defaults to localhost.

public static get ignoreNodes: NodeId[] source

These nodes (and their subnodes, if any) will be ignored by atscm. Defaults to Atviseproject.EditorRelatedNodes combined with Atviseproject.ServerRelatedNodes.

public static get login: boolean | Object source

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

Properties:

NameTypeAttributeDescription
username string

The username to log in with.
password string

The password to log in with.

Test:

public static get nodes: string[] | NodeId[] source

The atvise-server nodes that atscm should sync. Defaults to the nodes AGENT, SYSTEM, ObjectTypes.PROJECT and VariableTypes.PROJECT.

Test:

public static get nodesToWatch: string[] | NodeId[] source

The atvise-server nodes to watch in the corresponding tasks. Defaults to all nodes containing displays.

Test:

public static get port: Object source

The atvise-server ports to use.

Properties:

NameTypeAttributeDescription
opc number
  • optional
  • default: 4840

The OPC-UA port the atvise-server runs on.
http number
  • optional
  • default: 80

The HTTP port the atvise-server can be reached at.

public static get preserveSortOrderNodes: boolean since 1.0.0 source

this get was deprecated. Mapping source order nodes leads to inconsistent results in many cases.

If atvise builder sort order nodes should be stored.

public static get timeout: number source

The connection timeout, in milliseconds.

public static get useTransformers: Transformer[] source

The transformers to use in this project. Returns a DisplayTransformer, a ScriptTransformer and a NewlinesTransformer by default.

public static get vcs: 'git' | 'svn' since 1.0.0 source

The version control system to optimize tasks for.

Static Public Methods

public static inspect(): Object source

Returns an object containing the properties to inspect.

Return:

Object

The object to inspect.

Test:

See: