The 'Command' parameter is a string that represents the +command you want to execute. It can be any valid command that can be executed in a +terminal or command prompt.
+OptionalEcho: false | ((Return: any, _Error?: boolean) => Promise<void>)An optional parameter that controls whether the stdout and stderr +of the child process should be logged. If set to 'false', no logging will occur. If set +to a function, the function will be called with the stdout and stderr data as a parameter for custom +logging. If not provided, stdout and stderr will be logged to the console by default.
+The 'Exec' function is an asynchronous function that executes a command and logs the +stdout and stderr of the child process.
+The 'Command' parameter is a string that represents the +command you want to execute. It can be any valid command that can be executed in a +terminal or command prompt.
+OptionalEcho: false | ((Return: any, _Error?: boolean) => Promise<void>)An optional parameter that controls whether the stdout and stderr +of the child process should be logged. If set to 'false', no logging will occur. If set +to a function, the function will be called with the stdout and stderr data as a parameter for custom +logging. If not provided, stdout and stderr will be logged to the console by default.
+Represents a function that processes file patterns.
+An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
+OptionalOption: { OptionalFolder?: stringA string representing the Folder option.
+The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
+Starting from leftmost {from} parameter, resolves {to} to an absolute path.
+If {to} isn't already absolute, {from} arguments are prepended in right to left order, +until an absolute path is found. If after using all {from} paths still no absolute path is found, +the current working directory is used as well. The resulting path is normalized, +and trailing slashes are removed unless the path gets resolved to the root directory.
+Rest...paths: string[]A sequence of paths or path segments.
+The function 'JSON' is a TypeScript function that reads a JSON file and returns its +parsed content.
+The File parameter is a string that represents the name or
+path of the JSON file that you want to parse.
OptionalFrom: stringThe From parameter is an optional string that represents
+the directory path from which the JSON file should be loaded. If From is provided,
+it will be used as the base directory path. If From is not provided, the current
+directory will be used as the base directory path.
Document all your TypeScript files using TypeDoc.
+Add configuration and setup scripts:
+npm install -D -E @playform/document
+package.json
{
"scripts": {
"Document": "Document 'Source/**/*.ts'"
}
}
+Document 'Source/**/*.ts'
+The 'Exec' function is an asynchronous function that executes a command and logs the +stdout and stderr of the child process.
+The 'Command' parameter is a string that represents the +command you want to execute. It can be any valid command that can be executed in a +terminal or command prompt.
+OptionalEcho: false | ((Return: any, _Error?: boolean) => Promise<void>)An optional parameter that controls whether the stdout and stderr +of the child process should be logged. If set to 'false', no logging will occur. If set +to a function, the function will be called with the stdout and stderr data as a parameter for custom +logging. If not provided, stdout and stderr will be logged to the console by default.
+Represents a function that processes file patterns.
+An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
+OptionalOption: { OptionalFolder?: stringA string representing the Folder option.
+The function 'JSON' is a TypeScript function that reads a JSON file and returns its +parsed content.
+The File parameter is a string that represents the name or
+path of the JSON file that you want to parse.
OptionalFrom: stringThe From parameter is an optional string that represents
+the directory path from which the JSON file should be loaded. If From is provided,
+it will be used as the base directory path. If From is not provided, the current
+directory will be used as the base directory path.
ConstConst
The 'Exec' function is an asynchronous function that executes a command and logs the +stdout and stderr of the child process.
+