Skip to content

Commit

Permalink
squash!
Browse files Browse the repository at this point in the history
  • Loading branch information
NikolaRHristov committed Apr 2, 2024
1 parent 1df8638 commit 7875c4a
Show file tree
Hide file tree
Showing 14 changed files with 175 additions and 0 deletions.
File renamed without changes.
7 changes: 7 additions & 0 deletions Target/Class/Document.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env node
/**
* @module Document
*
*/
declare const _default: import("commander").Command;
export default _default;
File renamed without changes.
7 changes: 7 additions & 0 deletions Target/Class/Theme.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* @module Theme
*
*/
import { DefaultTheme } from "typedoc";
export default class extends DefaultTheme {
}
11 changes: 11 additions & 0 deletions Target/Function/Document.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/**
* @module Document
*
*/
declare const _default: Type;
export default _default;
import type Type from "../Interface/Build.js";
export declare const Exec: import("@Interface/Exec.js").default;
export declare const resolve: (...paths: string[]) => string;
export declare const Pipe: string[];
export declare const Current: string;
7 changes: 7 additions & 0 deletions Target/Function/Exec.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* @module Exec
*
*/
declare const _default: Type;
export default _default;
import type Type from "../Interface/Exec.js";
7 changes: 7 additions & 0 deletions Target/Function/JSON.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* @module JSON
*
*/
declare const _default: Type;
export default _default;
import type Type from "../Interface/JSON.js";
23 changes: 23 additions & 0 deletions Target/Interface/Build.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/**
* @module Build
*
*/
export default interface Type {
/**
* Represents a function that processes file patterns.
*
* @param File - An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.
*
* @param Option - An optional object that can contain two properties.
*
* @param Option.ESBuild - A string representing the ESBuild option.
*
* @param Option.TypeScript - A string representing the TypeScript option.
*
*/
(File: Pattern[], Option?: {
ESBuild?: string;
TypeScript?: string;
}): Promise<void>;
}
import type { Pattern } from "fast-glob";
21 changes: 21 additions & 0 deletions Target/Interface/Exec.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/**
* @module Exec
*
*/
export default interface Type {
/**
* The 'Exec' function is an asynchronous function that executes a command and logs the
* stdout and stderr of the child process.
*
* @param Command - 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.
*
* @param Echo - 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.
*
*/
(Command: string, Echo?: false | ((Return: any) => void)): Promise<void>;
}
20 changes: 20 additions & 0 deletions Target/Interface/JSON.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/**
* @module JSON
*
*/
export default interface Type {
/**
* The function 'JSON' is a TypeScript function that reads a JSON file and returns its
* parsed content.
*
* @param File - The `File` parameter is a string that represents the name or
* path of the JSON file that you want to parse.
*
* @param From - The `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.
*
*/
(File: string, From?: string): Promise<ReturnType<typeof JSON.parse>>;
}
15 changes: 15 additions & 0 deletions Target/Interface/Load.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/**
* @module Load
*
*/
export default interface Type {
/**
* The `Load` function is responsible for loading a plugin into the TypeDoc instance.
*
* @param Application - The `Application` parameter is an instance of TypeDoc's Application
* class, representing the TypeDoc application to which the plugin should be loaded.
*
*/
load: (Application: Application) => void;
}
import type { Application } from "typedoc";
19 changes: 19 additions & 0 deletions Target/Interface/Mapping.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/**
* @module Mapping
*
* Defines a mapping of a Models to a template file.
*
* Used by DefaultTheme to map reflections to output files.
*
*/
export default interface Type {
/**
* DeclarationReflection.kind this rule applies to.
*/
Kind: ReflectionKind[];
/**
* The name of the directory the output files should be written to.
*/
Directory: string;
}
import type { ReflectionKind } from "typedoc";
29 changes: 29 additions & 0 deletions Target/Interface/Theme.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/**
* @module Theme
*
* Represents an interface for defining a theme with various methods and properties.
*/
export default interface Type extends DefaultTheme {
/**
* A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.
*
* @param Reflection - The DeclarationReflection for which URLs are being built.
*
* @param URLs - An array of URLs mappings with any data type.
*
*/
buildUrls: (Reflection: DeclarationReflection, URLs: UrlMapping<any>[]) => UrlMapping<any>[];
/**
* A function that maps a DeclarationReflection to a Mapping or returns undefined.
*
* @param Reflection - The DeclarationReflection to map to a Mapping.
*
*/
_Mapping: (Reflection: DeclarationReflection) => Mapping | undefined;
/**
* An array of Mappings representing the theme's mapping configuration.
*/
Mapping: Mapping[];
}
import type Mapping from "./Mapping.js";
import type { DeclarationReflection, DefaultTheme, UrlMapping } from "typedoc";
9 changes: 9 additions & 0 deletions Target/Variable/Load.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* @module Load
*
*/
export declare const load: (Application: import("typedoc").Application) => void;
declare const _default: Type;
export default _default;
import type Type from "../Interface/Load.js";
export declare const Theme: typeof import("../Class/Theme.js").default;

0 comments on commit 7875c4a

Please sign in to comment.