Rest ...objects: TsRest...objects: TsRepresents a function that processes file patterns.
+Represents a function that processes file patterns.
An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
-Optional Option: { An optional object that can contain two properties.
-Optional ESBuild?: stringA string representing the ESBuild option.
-Optional TypeA string representing the TypeScript option.
-Optional Watch?: booleanOptionalOption: { An optional object that can contain two properties.
+OptionalESBuild?: stringA string representing the ESBuild option.
+OptionalTypeA string representing the TypeScript option.
+OptionalWatch?: booleanThe 'Exec' function is an asynchronous function that executes a command and logs the +
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 +
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.
-Optional Echo: false | ((Return) => 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 +
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 function 'JSON' is a TypeScript function that reads a JSON file and returns its +
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.
Optional From: stringThe From parameter is an optional string that represents
+
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.
Rest ...objects: TsRest...objects: TsBuilds all your TypeScript files into JavaScript.
-Add configuration and setup scripts:
-npm install -D -E @playform/build
-Through a command line run:
-npx @playform/build 'Source/**/*.ts'
-Builds all your TypeScript files into JavaScript.
+Add configuration and setup scripts:
+npm install -D -E @playform/build
+Through a command line run:
+npx @playform/build 'Source/**/*.ts'
+Help:
-Usage: Build [options] <File...>
🌀 Build —
Arguments:
File 📝 File —
Options:
-V, --version output the version number
-ES, --ESBuild <File> 📜 ESBuild —
-TS, --TypeScript <File> 📜 TypeScript — (default: "tsconfig.json")
-W --Watch 👁️ Watch —
-h, --help display help for command
-or in a package.json file:
{
"scripts": {
"Run": "Build 'Source/**/*.ts' --Watch",
"prepublishOnly": "Build 'Source/**/*.ts'"
}
}
-Or with a custom ESBuild config file:
+Usage: Build [options] <File...>
🌀 Build —
Arguments:
File 📝 File —
Options:
-V, --version output the version number
-ES, --ESBuild <File> 📜 ESBuild —
-TS, --TypeScript <File> 📜 TypeScript — (default: "tsconfig.json")
-W --Watch 👁️ Watch —
-h, --help display help for command
+Or in a package.json file:
{
"scripts": {
"Run": "Build 'Source/**/*.ts' --Watch",
"prepublishOnly": "Build 'Source/**/*.ts'"
}
}
+Or with a custom ESBuild config file:
package.json
{
"scripts": {
"prepublishOnly": "Build 'Source/**/*.ts' --ESBuild ESBuild.ts"
}
}
-{
"scripts": {
"prepublishOnly": "Build 'Source/**/*.ts' --ESBuild ESBuild.ts"
}
}
+See an example of a configuration file in -ESBuild.ts
-tsconfig.json
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "@playform/build/tsconfig",
"include": ["Source"]
}
-jsconfig.json
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "@playform/build/jsconfig",
"include": ["Source"]
}
-tsconfig.json
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "@playform/build/tsconfig",
"include": ["Source"]
}
+jsconfig.json
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "@playform/build/jsconfig",
"include": ["Source"]
}
+Represents a function that processes file patterns.
+Represents a function that processes file patterns.
An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
-Optional Option: { An optional object that can contain two properties.
-Optional ESBuild?: stringA string representing the ESBuild option.
-Optional TypeA string representing the TypeScript option.
-Optional Watch?: booleanOptionalOption: { An optional object that can contain two properties.
+OptionalESBuild?: stringA string representing the ESBuild option.
+OptionalTypeA string representing the TypeScript option.
+OptionalWatch?: booleanThe 'Exec' function is an asynchronous function that executes a command and logs the +
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 +
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.
-Optional Echo: false | ((Return) => 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 +
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 function 'JSON' is a TypeScript function that reads a JSON file and returns its +
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.
Optional From: stringThe From parameter is an optional string that represents
+
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.
Const ConstConst Const
The 'Exec' function is an asynchronous function that executes a command and logs the +
- Preparing search index...
- The search index is not available
@playform/build - v0.1.2Function Exec
The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.
-Parameters
The 'Command' parameter is a string that represents the +
Parameters
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) => 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 +
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.
-Returns Promise<void>
Settings
Member Visibility
Theme