References

summary
public	F addReferences(nodeId: NodeId, references: Object): Promise Adds references to a node.
public	F callMethod(methodId: NodeId, args: Array<node-opcua~Variant>): * Calls an OPC-UA method on the server.
public	F callScript(scriptId: NodeId, parameters: Object): * Calls a server script on the server.
public	F createNode(nodeId: NodeId, options: Object): * Creates a new Node on the server.
public	F async readNode(nodeId: NodeId): Promise<any> Reads a single node's value.
public	F writeNode(nodeId: NodeId, value: node-opcua~Variant): Promise<node-opcua~StatusCodes Writes a single node's value.

config

summary
public	C ProjectConfig The current project's configuration, with overrides (through `ATSCM_PROJECT__` env vars) already handled.
public	V path: string The path to the project's configuration file.

hooks

summary
public	F async approveToContinue(undefined: HookContext, error: Error): Promise
public	F async askForConfirmation(undefined: undefined): Promise
public	F async checkAtserver(context: HookContext): Promise
public	F async loadProjectRequirement(): Promise
public	F async loadRemoteVersion(): Promise
public	F async checkServerscripts(undefined: HookContext): Promise
public	F setupContext(undefined: Partial): HookContext

init

summary
public	C InitTask The action run when running "atscm init".
public	C InitOptionsValidator A static class containing validators for the options used when running "atscm init".
public	V ConfigLangs: Map<String, String> A map providing dirnames for config langs
public	V InitOptions: Object Options available for the "atscm init" command.
public	V InitOptionsAsArray: InitOption[] InitOptions, exported as an array.

lib

summary
public	F decodeVariant(buffer: Buffer, options: Object): * Returns a node-opcua~Variant from a Buffer with the given dataType and arrayType.
public	F encodeVariant(variant: node-opcua~Variant): Buffer Returns a buffer containing a node-opcua~Variants encoded value.
public	F escapeForRegExp(source: string): * Returns a string with all special regular expression characters escaped.
public	V specialChars: string[] Special characters in regular expressions.
public	V specialCharsRegExp: * A regular expression that matches all special characters in regular expressions.

lib/config

summary
public	C Atviseproject An atscm project's configuration.

lib/gulp

summary
public	C ImportStream A stream that imports xml files in parallel.
public	C PullStream A stream that transforms read ReadStream.ReadResults and stores the on the filesystem.
public	C PushStream A stream that transforms read vinyl~Files and pushes them to atvise server.
public	C WriteStream A stream that writes Nodes to the file system.
public	C FileNode A node returned by the SourceStream.
public	C SourceBrowser Browses the local file system for nodes.
public	F dest(path: string, options: Object): * Creates a new WriteStream to write to path.
public	F isDefinitionFile(path: string): boolean Returns `true` for definition file paths.
public	F src(path: string, options: SourceBrowserOptions): undefined Starts a new source browser at the given path.
public	V renameConfigPath: string Relative path to the rename file.

lib/helpers

summary
public	F pick(obj: Object, properties: Array<string>): Object Picks some properties from an object and returns a new object containing these.
public	F reverse(obj: Object): Object Switches keys and values in an object.
public	F delay(ms: ): Returns a promise that resolves after the given duration.
public	F promisified(fn: *) Wraps a function with an async callback in a promise.
public	F async updateFile(path: string, update: UpdateFn, encoding: undefined): Promise
public	F async updateJson(path: string, update: UpdateFn): Promise
public	F reportProgress(task: Promise<any>, options: Object): * Prints the progress of a task.
public	F sortReferences(references: Object): * Sorts the given references before they are persisted to disk.
public	F finishTask(): Promise<void> Closes open sessions once a task is complete.
public	F handleTaskError(error: Error) Adds additional infomation to the error's message and rethows it.

lib/init

summary
public	C InitOption An option the "atscm init" command handles.

lib/model

summary
public	C Node The main model class.
public	C ServerNode A node during a pull.
public	C SourceNode A node during a push.
public	V ReferenceTypeIds: {...OpcReferenceTypeIds: Object, "toParent": *} References type ids.
public	V ReferenceTypeNames: * Names for references.

lib/model/opcua

summary
public	C NodeId A wrapper around node-opcua~NodeId.
public	V ReverseReferenceTypeIds: Map<number, node-opcua~ReferenceTypeId Reverse map of node-opcua~ReferenceTypeIds.

lib/server

summary
public	C AddReferencesStream A stream that adds non-standard references to nodes when pushed.
public	C AtviseFile An extension to vinyl~File providing some additional, atvise-related properties.
public	C CreateNodeStream A stream that creates OPC-UA nodes for the passed AtviseFiless.
public	C BrowsedNode A node discovered while browsing the server's database.
public	C NodeBrowser Browses the server database.
public	C NodeStream A stream of server nodes.
public abstract	C QueueStream A stream that process atvise server requests in parallel.
public	C Session: Set<node-opcua~ClientSession> A wrapper around node-opcua~ClientSession used to connect to atvise server.
public	C Stream An object transform stream connected to atvise server.
public	C AtviseResourceType An atvise-related resource type.
public abstract	C WaitingStream A QueueStream that waits for a file's dependencies to be processed before the file is processed itself.
public	C Watcher Watches the given nodes for value changes.
public	C WriteStream A stream that writes all read AtviseFiles to their corresponding nodes on atvise server.
public	F waitForDependencies(Stream: QueueStream): Class<WaitingStream> A mixin that transforms a regular stream into a WaitingStream, which makes it wait for a node's dependencies to be transformed.
public	V DataTypeForExtension: * A map providing data types for shorter extensions (Reverse of DataTypeForExtension).
public	V ExtensionForDataType: Map<node-opcua~DataType, String> A map providing shorter extensions for data types
public	V AtviseTypes: AtviseType[] The atvise types to handle.
public abstract	T WWaiting#dependenciesFor(file: AtviseFile): NodeId[]: function(file: AtviseFile): NodeId[] Must be implemented by all subclasses: Returns the dependencies for a given file.

lib/server/scripts

summary
public abstract	C CallMethodStream A stream that calls an OPC-UA method for all input files.
public abstract	C CallScriptStream A stream that calls atvise server scripts for all passed nodes.
public	V versionNode: NodeId The node containing the currently installed server-scripts version.

lib/transform

summary
public	C ConfigTransformer
public abstract	C ModernPartialTransformer A transformer that transforms only some of the files read.
public	C SplittingTransformer A transformer that splits a node into multiple source nodes when pulling.
public abstract	C Transformer The base transformer class.
public	C XMLTransformer A transformer used to transform XML documents.
public	V TransformDirection: {FromDB: string, FromFilesystem: string} The directions a transformer can be run in.

tasks

summary
public	C WatchTask The task executed when running `atscm watch`.
public	F async importTask(): Promise<void> Imports all xml files needed for atscm usage.
public	F performPull(nodes: NodeId[], options: Object): * Pulls the given nodes from the server.
public	F async pull(options: Object): * Pulls all nodes from atvise server.
public	F performPush(path: string, options: Object): * Pushes the given path to the server.
public	F async push(): * Pushes AtviseFiles to atvise server.
public	F async watch(options: Object): Promise<{serverwatcher: Watcher, fileWatcher: sane~Watcher}, Error> The gulp task invoced when running `atscm watch`.

transform

summary
public	C LintTransformer A transformer ensuring no invalid alarm condition filter nodes are pulled.
public	C MappingTransformer A Transformer that maps ReadStream.ReadResults to AtviseFiles.
public	C NewlinesTransformer A transformer that handles newline characters in files.

typedef

summary
public	T NodeStream.BrowseResult: Object
public	T ReadStream.ReadResult: NodeStream.BrowseResult

typedef/external

summary
public	T inquirer~PromptType: String Must be one of: 'list', 'rawlist', 'expand', 'checkbox', 'confirm', 'input', 'password', 'editor'.
public	T inquirer~Validator: function(value: String): Boolean \| String A function that, when called with a value, validates this value and either retunrs `true` if validation succeeded or an error message.
public	E Inquirer
public	E node-opcua
public	E node-opcua~CallMethodRequest
public	E node-opcua~ClientSession
public	E node-opcua~ClientSubscription
public	E node-opcua~DataType
public	E node-opcua~DataValue
public	E node-opcua~NodeClass
public	E node-opcua~NodeId
public	E node-opcua~NodeIdType
public	E node-opcua~OPCUAClient
public	E node-opcua~ReferenceDescription
public	E node-opcua~ReferenceTypeId
public	E node-opcua~StatusCodes
public	E node-opcua~Variant
public	E node-opcua~VariantArrayType
public	E events~Emitter
public	E fs~Stats
public	E util~inspect
public	E p-queue~PQueue
public	E sane~Watcher
public	E vinyl~File
public	E xml2js~Builder

util

summary
public	F cleanup(exitCode: number, signal: string, uninstall: function()): boolean Cleans up after the app ended with the specified code or signal.
public	F getStat(path: string): Promise<fs~Stats, Error> Returns the fs~Stats for a path.
public	F validateDirectoryExists(directoryPath: string): Promise<fs~Stats, Error> Checks it a given path holds a directory and returns it's fs~Stats if found.

Directories