@360works/fmpromise/src/types.ts

Richer FileMaker WebViewer

abstract class RunningScript {
	/** After a currently running FileMaker script has completed, queued FileMaker scripts are run in order. If FileMaker script execution is canceled, the queue is cleared. (This is the behavior if option is not specified. This is also the default behavior for FileMaker.PerformScript() starting in version 19.1.2. */
	static readonly Continue: number = 0

	/** Execution of a currently running FileMaker script is halted, and all other pending scripts (queued or in the call stack) are canceled. Then script is run */
	static readonly Halt: number = 1

	/** A currently paused FileMaker script is exited. If the current FileMaker script was called by another FileMaker script, control returns to the calling FileMaker script until no more scripts remain in the call stack. Then script is run */
	static readonly Exit: number = 2

	/** A paused FileMaker script is resumed. After the resumed script is completed, script is run */
	static readonly Resume: number = 3

	/** A paused FileMaker script remains paused. If the paused script is resumed and completed, then script is run */
	static readonly Pause: number = 4

	/** A currently running FileMaker script is interrupted and script is run. When script is completed, the interrupted script resumes with the next script step. A paused script remains paused while script is run. (This is the behavior of FileMaker.PerformScript() in version 19.0. */
	static readonly Interrupt: number = 5

}

interface ScriptOptions {
	/**
	 * @see RunningScript for constant definitions
	 */
	runningScript?: 0 | 1 | 2 | 3 | 4 | 5;

	/**
	 * If `true` no attempt will be made to parse a script result value as JSON.
	 */
	alwaysReturnString?: boolean
}

export {RunningScript, ScriptOptions}