Build for d2edaa2

Author: Build Action

dist/index.js

@@ -0,0 +1,2 @@
+import * as matlab from "./matlab";
+export { matlab };

lib/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Helper interface to represent a MATLAB script.
+ */
+export interface HelperScript {
+    dir: string;
+    command: string;
+}
+/**
+ * Type of a function that executes a command on a runner and returns the error
+ * code.
+ */
+export declare type ExecFn = (command: string, args?: string[]) => Promise<number>;
+/**
+ * Generate a MATLAB script in the temporary directory that runs a command in
+ * the workspace.
+ *
+ * @param workspaceDir CI job workspace directory
+ * @param command MATLAB command to run
+ */
+export declare function generateScript(workspaceDir: string, command: string): Promise<HelperScript>;
+/**
+ * Run a HelperScript in MATLAB.
+ *
+ * Create the HelperScript using `generateScript`.
+ *
+ * @param hs HelperScript pointing to the script containing the command
+ * @param platform Operating system of the runner (e.g., "win32" or "linux")
+ * @param fn ExecFn that will execute a command on the runner
+ */
+export declare function runCommand(hs: HelperScript, platform: string, fn: ExecFn): Promise<void>;
+/**
+ * Get the path of the script containing RunMATLABCommand for the host OS.
+ *
+ * @param platform Operating system of the runner (e.g., "win32" or "linux")
+ */
+export declare function getRmcPath(platform: string): string;

lib/index.js

@@ -0,0 +1,21 @@
+/**
+ * Generate MATLAB command for changing directories and calling a command in it.
+ *
+ * @param dir Directory to change to.
+ * @param command Command to run in directory.
+ * @returns MATLAB command.
+ */
+export declare function cdAndCall(dir: string, command: string): string;
+/**
+ * Convert a path-like string to MATLAB character vector literal.
+ *
+ * @param s Input string.
+ * @returns Input string in MATLAB character vector literal.
+ */
+export declare function pathToCharVec(s: string): string;
+/**
+ * Convert an identifier (i.e., a script name) to one that is callable by MATLAB.
+ *
+ * @param s Input identifier.
+ */
+export declare function safeName(s: string): string;