import Internals from '@nautoguide/ourthings/ourthings/Queueable/Internals.js'

public class | source

Internals

Extends:

Queueable → Internals

Method Summary

Public Methods
public	deleteMemory(pid: int, json: object) Delete a memory value
public	deleteRegister(pid: int, json: object) delete a register
public	execute(pid: int, json: object) Execute a prepared queue
public	ifqueue(pid: int, json: object) Check a statement and run prepared queue if its true
public	nop(pid: int, json: object) NOP - No operation
public	pushMemory(pid: int, json: object) push a value to an array memory value
public	setMemory(pid: int, json: object) Set a memory value
public	setRegister(pid: int, json: object) Set a register

Inherited Summary

From class Queueable
public	queue: *
public	ready: boolean
public	finished(pid: , mode: ) Call this method after you command has finished.
public	init(queue: *) init, override this for any promise based inits setting the self.ready=true after the promise
public	set(pid: , value: )
public	start(pid: , command: , json: *) Called from queue, starts running the actual command

Public Methods

public deleteMemory(pid: int, json: object) source

Delete a memory value

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.name	string		name of memory item
json.value	*		value to set (can be any type)
json.mode	string	optional	[Garbage\|Session\|Permanent] Memory mode

Example:

internals.setMemory({"name":"test","mode":"Session","value":"Test String"});
internals.setMemory({"name":"test","mode":"Session","value":{"trueFalse":[true,false],"objects":[{"ElementOne":"Result One"},{"ElementTwo":"Result Two"}]}});

public deleteRegister(pid: int, json: object) source

delete a register

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.name	string		name of register

Example:

internals.deleteRegister({"name":"test"});

public execute(pid: int, json: object) source

Execute a prepared queue

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.name	string		prepared queue to call
json.silentFail	boolean		fail the queue silently?
json.json	object	optional	New arguments to send to queue

Example:

internals.execute({"name":"myQueue"});

public ifqueue(pid: int, json: object) source

Check a statement and run prepared queue if its true

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.statement	string		statement to check
json.name	string		prepared queue to call
json.else	string		prepared queue to call on else
json.json	object	optional	New arguments to send to queue

Example:

internals.ifqueue({"statement":"memory.loginAPI.value.token","name":"loggedIn"});

public nop(pid: int, json: object) source

NOP - No operation

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments

Example:

internals.nop();

public pushMemory(pid: int, json: object) source

push a value to an array memory value

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.name	string		name of memory item
json.toggle	boolean		toggle unique items
json.value	*		value to set (can be any type)
json.mode	string	optional	[Garbage\|Session\|Permanent] Memory mode

Example:

internals.pushMemory({"name":"test","mode":"Session","value":"Test String"});
internals.pushMemory({"name":"test","mode":"Session","value":{"trueFalse":[true,false],"objects":[{"ElementOne":"Result One"},{"ElementTwo":"Result Two"}]}});

public setMemory(pid: int, json: object) source

Set a memory value

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.name	string		name of memory item
json.value	*		value to set (can be any type)
json.mode	string	optional	[Garbage\|Session\|Permanent] Memory mode

Example:

internals.setMemory({"name":"test","mode":"Session","value":"Test String"});
internals.setMemory({"name":"test","mode":"Session","value":{"trueFalse":[true,false],"objects":[{"ElementOne":"Result One"},{"ElementTwo":"Result Two"}]}});

public setRegister(pid: int, json: object) source

Set a register

Params:

Name	Type	Attribute	Description
pid	int		process ID
json	object		queue arguments
json.name	string		name of register

Example:

internals.setRegister({"name":"test"});