diff --git a/Documentation/.nojekyll b/Documentation/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/Documentation/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/Documentation/Class/TypeDoc.TypeDoc-1.html b/Documentation/Class/TypeDoc.TypeDoc-1.html new file mode 100644 index 00000000..2e5219b6 --- /dev/null +++ b/Documentation/Class/TypeDoc.TypeDoc-1.html @@ -0,0 +1,742 @@ +
The name of this component as set by the @Component
decorator.
Internal
markedStatic
URL_Private
_listenA unique id that identifies this instance.
+Return the application / root component instance.
+Return the owner of this component.
+Protected
bubbleIf implementing a custom theme, it is recommended to override buildNavigation instead.
+Map the models of the given project to the desired output files.
+The project whose urls should be generated.
+A list of UrlMapping instances defining which models + should be rendered to which files.
+ +Protected
initializeInversion-of-control versions of on
. Tell this object to listen to
+an event in another object... keeping track of what it's listening to
+for easier unbinding later.
Optional
callback: EventCallbackOptional
priority: numberInversion-of-control versions of once
.
Optional
priority: numberRemove one or many callbacks. If context
is null, removes all
+callbacks with that function. If callback
is null, removes all
+callbacks for the event. If name
is null, removes all bound
+callbacks for all events.
Optional
context: anyOptional
callback: EventCallbackOptional
context: anyBind an event to a callback
function. Passing "all"
will bind
+the callback to all events fired.
Optional
context: anyOptional
callback: EventCallbackOptional
context: anyOptional
priority: numberOptional
context: anyOptional
priority: numberBind an event to only be triggered a single time. After the first time +the callback is invoked, its listener will be removed. If multiple events +are passed in using the space-separated syntax, the handler will fire +once for each event, not once for a combination of all events.
+Optional
context: anyOptional
context: anyOptional
priority: anyTell this object to stop listening to either specific events ... or +to every object it's currently listening to.
+Optional
obj: EventDispatcherOptional
name: string | EventMapOptional
callback: EventCallbackTrigger one or many events, firing all bound callbacks. Callbacks are
+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[]Static
applyGenerate an anchor url for the given reflection and all of its children.
+The reflection an anchor url should be created for.
+The nearest reflection having an own document.
+Static
getReturn a url for the given reflection.
+The reflection the url should be generated for.
+Optional
relative: ReflectionThe parent reflection the url generation should stop on.
+Optional
separator: stringThe separator used to generate the url.
+The generated url.
+ +Generated using TypeDoc
Optional
r_1: { Optional
hideOptional
r_1: { Optional
arrowOptional
hideAvoid this in favor of urlTo if possible
+Optional
cacheBust: booleanGenerated using TypeDoc
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.
+Generated using TypeDoc
The 'Exec' function is an asynchronous function that executes a command and logs the +stdout 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.
+Optional
Echo: false | ((Return) => void)An optional parameter that controls whether the stdout +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 data as a parameter for custom +logging. If not provided, stdout will be logged to the console by default.
+Generated using TypeDoc
Deeply merge objects.
+Rest
...objects: readonly [Ts]The objects to merge.
+Generated using TypeDoc
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.
+if any of the arguments is not a string.
+Generated using TypeDoc
The 'Exec' function is an asynchronous function that executes a command and logs the +stdout 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.
+Optional
Echo: false | ((Return) => void)An optional parameter that controls whether the stdout +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 data as a parameter for custom +logging. If not provided, stdout will be logged to the console by default.
+Generated using TypeDoc
Generated using TypeDoc
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
+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.
Generated using TypeDoc
Generated using TypeDoc
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.
+Generated using TypeDoc
The 'Exec' function is an asynchronous function that executes a command and logs the +stdout 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.
+Optional
Echo: false | ((Return) => void)An optional parameter that controls whether the stdout +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 data as a parameter for custom +logging. If not provided, stdout will be logged to the console by default.
+Generated using TypeDoc
Generated using TypeDoc
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
+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.
Generated using TypeDoc
Generated using TypeDoc
Optional
r_1: { Optional
hideOptional
r_1: { Optional
arrowOptional
hideAvoid this in favor of urlTo if possible
+Optional
cacheBust: booleanGenerated using TypeDoc
rome-ignore lint/suspicious/noExplicitAny:
+Generated using TypeDoc
The name of the directory the output files should be written to.
+DeclarationReflection.kind this rule applies to.
+rome-ignore lint/suspicious/noExplicitAny:
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const
Generated using TypeDoc
Const
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Builds all your TypeScript files into JavaScript.
+Add configuration and setup scripts:
+npm install -D -E typescript-esbuild
+
+package.json
{
"name": "package",
"scripts": {
"prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts'"
},
"devDependencies": {
"typescript-esbuild": "0.2.4"
}
}
+
+Or with a custom esbuild config file:
+{
"scripts": {
"prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts' -es ESBuild.ts"
}
}
+
+See an example of a configuration file in +Configuration.ts
+tsconfig.json
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "typescript-esbuild/Target/Notation/TypeScript",
"include": ["Source"]
}
+
+Generated using TypeDoc
Create a new DefaultTheme instance.
+