Optional relative: ReflectionOptional separator: stringThe separator used to generate the url.
The generated url.
-The '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 command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ 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 right-most parameter is considered {to}. Other parameters are considered an array of {from}.
+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, @@ -6,4 +6,4 @@ and trailing slashes are removed unless the path gets resolved to the root directory.
Rest ...paths: string[]A sequence of paths or path segments.
if any of the arguments is not a string.
-The '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 command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ 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.
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.
+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'"
}
}
Represents a function that processes file patterns.
+The '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 command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ 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.
-DeclarationReflection.kind this rule applies to.
+An array of Mappings representing the theme's mapping configuration.
-A function that maps a DeclarationReflection to a Mapping or returns undefined.
+A function that maps a DeclarationReflection to a Mapping or returns undefined.
A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.
+A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.
The DeclarationReflection for which URLs are being built.
An array of URLs mappings with any data type.
-The name of this component as set by the @Component decorator.
The name of this component as set by the @Component decorator.
The icons which will actually be rendered. The source of truth lives on the theme, and the DefaultThemeRenderContext.icons member will produce references to these.
These icons will be written twice. Once to an icons.svg file in the assets directory
@@ -71,4 +71,4 @@
passed the same arguments as trigger is, apart from the event name
(unless you're listening on "all", which will cause your callback to
receive the true name of the event as the first argument).
Rest ...args: any[]Rest ...args: any[]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.
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.
-The Load function is responsible for loading a plugin into the TypeDoc instance.
The Application parameter is an instance of TypeDoc's Application
class, representing the TypeDoc application to which the plugin should be loaded.
Const Const Const Const
The parent reflection the url generation should stop on.