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 @@ +TypeDoc | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Class TypeDoc

+
+

Hierarchy

+
    +
  • DefaultTheme +
      +
    • TypeDoc
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
    + +
  • +

    Create a new DefaultTheme instance.

    +
    +
    +

    Parameters

    +
      +
    • +
      renderer: Renderer
      +

      The renderer this theme is attached to.

      +
      +
    +

    Returns TypeDoc

    +
+
+

Properties

+
+ +
Mapping: Type[] = ...
+
+ +
componentName: string
+

The name of this component as set by the @Component decorator.

+
+
+
+ +
defaultLayoutTemplate: ((pageEvent, template) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (pageEvent, template): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        pageEvent: PageEvent<Reflection>
      • +
      • +
        template: RenderTemplate<PageEvent<Reflection>>
      +

      Returns JsxElement

+
+ +
indexTemplate: ((pageEvent) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (pageEvent): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        pageEvent: PageEvent<ProjectReflection>
      +

      Returns JsxElement

+
+ +
markedPlugin: MarkedPlugin
+
+
+ +
reflectionTemplate: ((pageEvent) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (pageEvent): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        pageEvent: PageEvent<ContainerReflection>
      +

      Returns JsxElement

+
+ +
URL_PREFIX: RegExp
+
+

Accessors

+
+ +
    +
  • get _listenId(): any
  • +
  • +

    A unique id that identifies this instance.

    +
    +

    Returns any

    +
+
+ +
    +
  • get application(): Application
  • +
  • +

    Return the application / root component instance.

    +
    +

    Returns Application

    +
+
+ +
    +
  • get owner(): O
  • +
  • +

    Return the owner of this component.

    +
    +

    Returns O

    +
+
+

Methods

+
+ +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string | Event | EventMap
    • +
    • +
      Rest ...args: any[]
    +

    Returns TypeDoc

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      project: ProjectReflection
    +

    Returns NavigationElement[]

+
+ +
+
+ +
    + +
  • +

    If implementing a custom theme, it is recommended to override buildNavigation instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      project: ProjectReflection
    +

    Returns NavigationElement[]

    +
+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      reflection: DeclarationReflection
    +

    Returns string

+
+ +
+
+ +
    + +
  • +

    Map the models of the given project to the desired output files.

    +
    +
    +

    Parameters

    +
      +
    • +
      project: ProjectReflection
      +

      The project whose urls should be generated.

      +
      +
    +

    Returns UrlMapping<any>[]

    A list of UrlMapping instances defining which models + should be rendered to which files.

    + +
+
+ +
    + +
  • +

    Initialize this component.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    Inversion-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.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: EventDispatcher
    • +
    • +
      name: string | EventMap
    • +
    • +
      Optional callback: EventCallback
    • +
    • +
      Optional priority: number
    +

    Returns TypeDoc

    +
+
+ +
    + +
  • +

    Inversion-of-control versions of once.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: EventDispatcher
    • +
    • +
      eventMap: EventMap
    +

    Returns TypeDoc

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      obj: EventDispatcher
    • +
    • +
      name: string
    • +
    • +
      callback: EventCallback
    • +
    • +
      Optional priority: number
    +

    Returns TypeDoc

+
+ +
    + +
  • +

    Remove 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.

    +
    +

    Returns TypeDoc

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      eventMap: undefined | EventMap
    • +
    • +
      Optional context: any
    +

    Returns TypeDoc

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      name: undefined | string
    • +
    • +
      Optional callback: EventCallback
    • +
    • +
      Optional context: any
    +

    Returns TypeDoc

+
+ +
    + +
  • +

    Bind an event to a callback function. Passing "all" will bind +the callback to all events fired.

    +
    +
    +

    Parameters

    +
      +
    • +
      eventMap: EventMap
    • +
    • +
      Optional context: any
    +

    Returns TypeDoc

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      eventMap: EventMap
    • +
    • +
      Optional callback: EventCallback
    • +
    • +
      Optional context: any
    • +
    • +
      Optional priority: number
    +

    Returns TypeDoc

  • + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string
    • +
    • +
      callback: EventCallback
    • +
    • +
      Optional context: any
    • +
    • +
      Optional priority: number
    +

    Returns TypeDoc

+
+ +
    + +
  • +

    Bind 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.

    +
    +
    +

    Parameters

    +
      +
    • +
      eventMap: EventMap
    • +
    • +
      Optional context: any
    +

    Returns TypeDoc

    +
  • + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string
    • +
    • +
      callback: EventCallback
    • +
    • +
      Optional context: any
    • +
    • +
      Optional priority: any
    +

    Returns TypeDoc

+
+ +
    + +
  • +
    +

    Parameters

    +
      +
    • +
      page: PageEvent<Reflection>
    • +
    • +
      template: RenderTemplate<PageEvent<Reflection>>
    +

    Returns string

+
+ +
    + +
  • +

    Tell this object to stop listening to either specific events ... or +to every object it's currently listening to.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional obj: EventDispatcher
    • +
    • +
      Optional name: string | EventMap
    • +
    • +
      Optional callback: EventCallback
    +

    Returns TypeDoc

    +
+
+ +
    + +
  • +

    Trigger 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).

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string | Event | EventMap
    • +
    • +
      Rest ...args: any[]
    +

    Returns TypeDoc

    +
+
+ +
    + +
  • +

    Generate an anchor url for the given reflection and all of its children.

    +
    +
    +

    Parameters

    +
      +
    • +
      reflection: Reflection
      +

      The reflection an anchor url should be created for.

      +
      +
    • +
    • +
      container: Reflection
      +

      The nearest reflection having an own document.

      +
      +
    +

    Returns void

    +
+
+ +
    + +
  • +

    Return a url for the given reflection.

    +
    +
    +

    Parameters

    +
      +
    • +
      reflection: Reflection
      +

      The reflection the url should be generated for.

      +
      +
    • +
    • +
      Optional relative: Reflection
      +

      The parent reflection the url generation should stop on.

      +
      +
    • +
    • +
      Optional separator: string
      +

      The separator used to generate the url.

      +
      +
    +

    Returns string

    The generated url.

    + +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Class/TypeDoc.TypeDoc.html b/Documentation/Class/TypeDoc.TypeDoc.html new file mode 100644 index 00000000..456756e9 --- /dev/null +++ b/Documentation/Class/TypeDoc.TypeDoc.html @@ -0,0 +1,1024 @@ +TypeDoc | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Class TypeDoc

+
+

Hierarchy

+
    +
  • DefaultThemeRenderContext +
      +
    • TypeDoc
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
analytics: (() => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): undefined | JsxElement
    • +
    • +

      Returns undefined | JsxElement

+
+ +
breadcrumb: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns undefined | JsxElement

+
+ +
commentSummary: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): undefined | JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns undefined | JsxElement

+
+ +
commentTags: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): undefined | JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns undefined | JsxElement

+
+ +
defaultLayout: ((template, props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (template, props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        template: RenderTemplate<PageEvent<Reflection>>
      • +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
footer: (() => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): undefined | JsxElement
    • +
    • +

      Returns undefined | JsxElement

+
+ +
getNavigation: (() => NavigationElement[])
+
+

Type declaration

+
    +
  • +
      +
    • (): NavigationElement[]
    • +
    • +

      Returns NavigationElement[]

+
+ +
getReflectionClasses: ((refl) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (refl): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        refl: DeclarationReflection
      +

      Returns string

+
+ +
header: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
hierarchy: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): undefined | JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: undefined | DeclarationHierarchy
      +

      Returns undefined | JsxElement

+
+ +
hook: ((name) => JsxElement[])
+
+

Type declaration

+
    +
  • +
      +
    • (name): JsxElement[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        name: keyof RendererHooks
      +

      Returns JsxElement[]

+
+ +
index: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: ContainerReflection
      +

      Returns JsxElement

+
+ +
indexTemplate: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<ProjectReflection>
      +

      Returns JsxElement

+
+ +
markdown: ((md) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (md): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        md: undefined | string | readonly CommentDisplayPart[]
      +

      Returns string

+
+ +
member: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberDeclaration: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberGetterSetter: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberReference: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: ReferenceReflection
      +

      Returns JsxElement

+
+ +
memberSignatureBody: ((r_0, r_1?) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (r_0, r_1?): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        r_0: SignatureReflection
      • +
      • +
        Optional r_1: {
            hideSources?: boolean;
        }
        +
          +
        • +
          Optional hideSources?: boolean
      +

      Returns JsxElement

+
+ +
memberSignatureTitle: ((r_0, r_1?) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (r_0, r_1?): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        r_0: SignatureReflection
      • +
      • +
        Optional r_1: {
            arrowStyle?: boolean;
            hideName?: boolean;
        }
        +
          +
        • +
          Optional arrowStyle?: boolean
        • +
        • +
          Optional hideName?: boolean
      +

      Returns JsxElement

+
+ +
memberSignatures: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberSources: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection | SignatureReflection
      +

      Returns JsxElement

+
+ +
members: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: ContainerReflection
      +

      Returns JsxElement

+
+ +
membersGroup: ((group) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (group): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        group: ReflectionGroup
      +

      Returns JsxElement

+
+ +
navigation: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
options: Options
+
+ +
page: PageEvent<Reflection>
+
+ +
pageNavigation: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
pageSidebar: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
parameter: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
reflectionFlags: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns JsxElement

+
+ +
reflectionTemplate: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<ContainerReflection>
      +

      Returns JsxElement

+
+ +
relativeURL: ((url, cacheBust?) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (url, cacheBust?): string
    • +
    • +

      Avoid this in favor of urlTo if possible

      +
      +
      +

      Parameters

      +
        +
      • +
        url: string
      • +
      • +
        Optional cacheBust: boolean
      +

      Returns string

      +
+
+ +
settings: (() => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): JsxElement
    • +
    • +

      Returns JsxElement

+
+ +
sidebar: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
sidebarLinks: (() => null | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): null | JsxElement
    • +
    • +

      Returns null | JsxElement

+
+ +
toolbar: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
type: ((type) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (type): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        type: undefined | Type
      +

      Returns JsxElement

+
+ +
typeAndParent: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Type
      +

      Returns JsxElement

+
+ +
typeParameters: ((typeParameters) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (typeParameters): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        typeParameters: TypeParameterReflection[]
      +

      Returns JsxElement

+
+ +
urlTo: ((reflection) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (reflection): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        reflection: Reflection
      +

      Returns string

+
+

Accessors

+
+ +
    +
  • get icons(): Readonly<Record<"search" | "anchor" | ReflectionKind | "chevronDown" | "checkbox" | "menu" | "chevronSmall", (() => JsxElement)>>
  • +
  • +

    Returns Readonly<Record<"search" | "anchor" | ReflectionKind | "chevronDown" | "checkbox" | "menu" | "chevronSmall", (() => JsxElement)>>

  • +
  • set icons(value): void
  • +
  • +
    +

    Parameters

    +
      +
    • +
      value: Readonly<Record<"search" | "anchor" | ReflectionKind | "chevronDown" | "checkbox" | "menu" | "chevronSmall", (() => JsxElement)>>
    +

    Returns void

+
+

Methods

+
+ +
    + +
  • +

    Returns JsxElement

+
+ +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Build.Build.html b/Documentation/Function/Build.Build.html new file mode 100644 index 00000000..a119752a --- /dev/null +++ b/Documentation/Function/Build.Build.html @@ -0,0 +1,80 @@ +Build | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function Build

+
+
    + +
  • +

    Represents a function that processes file patterns.

    +
    +
    +

    Parameters

    +
      +
    • +
      File: string[]
      +

      An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      +
      +
    • +
    • +
      Optional Option: {
          ESBuild?: string;
          TypeScript?: string;
      }
      +

      An optional object that can contain two properties.

      +
      +
      +
        +
      • +
        Optional ESBuild?: string
        +

        A string representing the ESBuild option.

        +
        +
      • +
      • +
        Optional TypeScript?: string
        +

        A string representing the TypeScript option.

        +
        +
    +

    Returns Promise<void>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Build.Exec.html b/Documentation/Function/Build.Exec.html new file mode 100644 index 00000000..d26348c3 --- /dev/null +++ b/Documentation/Function/Build.Exec.html @@ -0,0 +1,75 @@ +Exec | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function Exec

+
+
    + +
  • +

    The 'Exec' function is an asynchronous function that executes a command and logs the +stdout of the child process.

    +
    +
    +

    Parameters

    +
      +
    • +
      Command: string
      +

      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.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Build.deepmerge.html b/Documentation/Function/Build.deepmerge.html new file mode 100644 index 00000000..3b099da2 --- /dev/null +++ b/Documentation/Function/Build.deepmerge.html @@ -0,0 +1,69 @@ +deepmerge | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function deepmerge

+
+
    + +
  • +

    Deeply merge objects.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      Ts extends readonly unknown[]

    +
    +

    Parameters

    +
      +
    • +
      Rest ...objects: readonly [Ts]
      +

      The objects to merge.

      +
      +
    +

    Returns DeepMergeHKT<Ts, DeepMergeMergeFunctionsDefaultURIs, DeepMergeBuiltInMetaData>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Build.resolve.html b/Documentation/Function/Build.resolve.html new file mode 100644 index 00000000..7bc87591 --- /dev/null +++ b/Documentation/Function/Build.resolve.html @@ -0,0 +1,71 @@ +resolve | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function resolve

+
+
    + +
  • +

    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.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...paths: string[]
      +

      A sequence of paths or path segments.

      +
      +
    +

    Returns string

    +
    +

    Throws

    if any of the arguments is not a string.

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Exec.Exec.html b/Documentation/Function/Exec.Exec.html new file mode 100644 index 00000000..f215e949 --- /dev/null +++ b/Documentation/Function/Exec.Exec.html @@ -0,0 +1,75 @@ +Exec | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function Exec

+
+
    + +
  • +

    The 'Exec' function is an asynchronous function that executes a command and logs the +stdout of the child process.

    +
    +
    +

    Parameters

    +
      +
    • +
      Command: string
      +

      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.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/File.File.html b/Documentation/Function/File.File.html new file mode 100644 index 00000000..854f84bb --- /dev/null +++ b/Documentation/Function/File.File.html @@ -0,0 +1,61 @@ +File | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function File

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/JSON.JSON.html b/Documentation/Function/JSON.JSON.html new file mode 100644 index 00000000..e3fc5397 --- /dev/null +++ b/Documentation/Function/JSON.JSON.html @@ -0,0 +1,74 @@ +JSON | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function JSON

+
+
    + +
  • +

    The function 'JSON' is a TypeScript function that reads a JSON file and returns its +parsed content.

    +
    +
    +

    Parameters

    +
      +
    • +
      File: string
      +

      The File parameter is a string that represents the name or +path of the JSON file that you want to parse.

      +
      +
    • +
    • +
      Optional From: string
      +

      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.

      +
      +
    +

    Returns Promise<any>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/TypeDoc.load.html b/Documentation/Function/TypeDoc.load.html new file mode 100644 index 00000000..08af8116 --- /dev/null +++ b/Documentation/Function/TypeDoc.load.html @@ -0,0 +1,58 @@ +load | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Function load

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Build.Type.html b/Documentation/Interface/Build.Type.html new file mode 100644 index 00000000..480a3bc6 --- /dev/null +++ b/Documentation/Interface/Build.Type.html @@ -0,0 +1,84 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
    + +
  • +

    Represents a function that processes file patterns.

    +
    +
    +

    Parameters

    +
      +
    • +
      File: string[]
      +

      An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      +
      +
    • +
    • +
      Optional Option: {
          ESBuild?: string;
          TypeScript?: string;
      }
      +

      An optional object that can contain two properties.

      +
      +
      +
        +
      • +
        Optional ESBuild?: string
        +

        A string representing the ESBuild option.

        +
        +
      • +
      • +
        Optional TypeScript?: string
        +

        A string representing the TypeScript option.

        +
        +
    +

    Returns Promise<void>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Exec.Type.html b/Documentation/Interface/Exec.Type.html new file mode 100644 index 00000000..383ae5ac --- /dev/null +++ b/Documentation/Interface/Exec.Type.html @@ -0,0 +1,79 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
    + +
  • +

    The 'Exec' function is an asynchronous function that executes a command and logs the +stdout of the child process.

    +
    +
    +

    Parameters

    +
      +
    • +
      Command: string
      +

      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.

      +
      +
    +

    Returns Promise<void>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/File.Type.html b/Documentation/Interface/File.Type.html new file mode 100644 index 00000000..0b7d8c65 --- /dev/null +++ b/Documentation/Interface/File.Type.html @@ -0,0 +1,65 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/JSON.Type.html b/Documentation/Interface/JSON.Type.html new file mode 100644 index 00000000..76fe3e6e --- /dev/null +++ b/Documentation/Interface/JSON.Type.html @@ -0,0 +1,78 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
    + +
  • +

    The function 'JSON' is a TypeScript function that reads a JSON file and returns its +parsed content.

    +
    +
    +

    Parameters

    +
      +
    • +
      File: string
      +

      The File parameter is a string that represents the name or +path of the JSON file that you want to parse.

      +
      +
    • +
    • +
      Optional From: string
      +

      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.

      +
      +
    +

    Returns Promise<any>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/TypeDoc.Type-1.html b/Documentation/Interface/TypeDoc.Type-1.html new file mode 100644 index 00000000..c4660e04 --- /dev/null +++ b/Documentation/Interface/TypeDoc.Type-1.html @@ -0,0 +1,86 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
load: ((Application) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (Application): void
    • +
    • +
      +

      Parameters

      +
        +
      • +
        Application: Application
      +

      Returns void

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/TypeDoc.Type-2.html b/Documentation/Interface/TypeDoc.Type-2.html new file mode 100644 index 00000000..ed5dcb4e --- /dev/null +++ b/Documentation/Interface/TypeDoc.Type-2.html @@ -0,0 +1,959 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • DefaultThemeRenderContext +
      +
    • Type
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
analytics: (() => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): undefined | JsxElement
    • +
    • +

      Returns undefined | JsxElement

+
+ +
breadcrumb: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns undefined | JsxElement

+
+ +
commentSummary: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): undefined | JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns undefined | JsxElement

+
+ +
commentTags: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): undefined | JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns undefined | JsxElement

+
+ +
defaultLayout: ((template, props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (template, props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        template: RenderTemplate<PageEvent<Reflection>>
      • +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
footer: (() => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): undefined | JsxElement
    • +
    • +

      Returns undefined | JsxElement

+
+ +
getNavigation: (() => NavigationElement[])
+
+

Type declaration

+
    +
  • +
      +
    • (): NavigationElement[]
    • +
    • +

      Returns NavigationElement[]

+
+ +
getReflectionClasses: ((refl) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (refl): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        refl: DeclarationReflection
      +

      Returns string

+
+ +
header: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
hierarchy: ((props) => undefined | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): undefined | JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: undefined | DeclarationHierarchy
      +

      Returns undefined | JsxElement

+
+ +
hook: ((name) => JsxElement[])
+
+

Type declaration

+
    +
  • +
      +
    • (name): JsxElement[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        name: keyof RendererHooks
      +

      Returns JsxElement[]

+
+ +
index: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: ContainerReflection
      +

      Returns JsxElement

+
+ +
indexTemplate: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<ProjectReflection>
      +

      Returns JsxElement

+
+ +
init: (() => void)
+
+

Type declaration

+
    +
  • +
      +
    • (): void
    • +
    • +

      Returns void

+
+ +
markdown: ((md) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (md): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        md: undefined | string | readonly CommentDisplayPart[]
      +

      Returns string

+
+ +
member: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberDeclaration: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberGetterSetter: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberReference: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: ReferenceReflection
      +

      Returns JsxElement

+
+ +
memberSignatureBody: ((r_0, r_1?) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (r_0, r_1?): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        r_0: SignatureReflection
      • +
      • +
        Optional r_1: {
            hideSources?: boolean;
        }
        +
          +
        • +
          Optional hideSources?: boolean
      +

      Returns JsxElement

+
+ +
memberSignatureTitle: ((r_0, r_1?) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (r_0, r_1?): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        r_0: SignatureReflection
      • +
      • +
        Optional r_1: {
            arrowStyle?: boolean;
            hideName?: boolean;
        }
        +
          +
        • +
          Optional arrowStyle?: boolean
        • +
        • +
          Optional hideName?: boolean
      +

      Returns JsxElement

+
+ +
memberSignatures: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
memberSources: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection | SignatureReflection
      +

      Returns JsxElement

+
+ +
members: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: ContainerReflection
      +

      Returns JsxElement

+
+ +
membersGroup: ((group) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (group): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        group: ReflectionGroup
      +

      Returns JsxElement

+
+ +
navigation: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
options: Options
+
+ +
page: PageEvent<Reflection>
+
+ +
pageNavigation: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
pageSidebar: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
parameter: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: DeclarationReflection
      +

      Returns JsxElement

+
+ +
reflectionFlags: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Reflection
      +

      Returns JsxElement

+
+ +
reflectionTemplate: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<ContainerReflection>
      +

      Returns JsxElement

+
+ +
relativeURL: ((url, cacheBust?) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (url, cacheBust?): string
    • +
    • +

      Avoid this in favor of urlTo if possible

      +
      +
      +

      Parameters

      +
        +
      • +
        url: string
      • +
      • +
        Optional cacheBust: boolean
      +

      Returns string

      +
+
+ +
settings: (() => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): JsxElement
    • +
    • +

      Returns JsxElement

+
+ +
sidebar: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
sidebarLinks: (() => null | JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (): null | JsxElement
    • +
    • +

      Returns null | JsxElement

+
+ +
toolbar: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: PageEvent<Reflection>
      +

      Returns JsxElement

+
+ +
type: ((type) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (type): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        type: undefined | Type
      +

      Returns JsxElement

+
+ +
typeAndParent: ((props) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (props): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        props: Type
      +

      Returns JsxElement

+
+ +
typeParameters: ((typeParameters) => JsxElement)
+
+

Type declaration

+
    +
  • +
      +
    • (typeParameters): JsxElement
    • +
    • +
      +

      Parameters

      +
        +
      • +
        typeParameters: TypeParameterReflection[]
      +

      Returns JsxElement

+
+ +
urlTo: ((reflection) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (reflection): string
    • +
    • +
      +

      Parameters

      +
        +
      • +
        reflection: Reflection
      +

      Returns string

+
+

Accessors

+
+ +
    +
  • get icons(): Readonly<Record<"search" | "anchor" | ReflectionKind | "chevronDown" | "checkbox" | "menu" | "chevronSmall", (() => JsxElement)>>
  • +
  • +

    Returns Readonly<Record<"search" | "anchor" | ReflectionKind | "chevronDown" | "checkbox" | "menu" | "chevronSmall", (() => JsxElement)>>

  • +
  • set icons(value): void
  • +
  • +
    +

    Parameters

    +
      +
    • +
      value: Readonly<Record<"search" | "anchor" | ReflectionKind | "chevronDown" | "checkbox" | "menu" | "chevronSmall", (() => JsxElement)>>
    +

    Returns void

+
+

Methods

+
+ +
    + +
  • +

    Returns JsxElement

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/TypeDoc.Type-3.html b/Documentation/Interface/TypeDoc.Type-3.html new file mode 100644 index 00000000..8ac717b1 --- /dev/null +++ b/Documentation/Interface/TypeDoc.Type-3.html @@ -0,0 +1,142 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
+ +
Mapping: Type[]
+
+ +
_Mapping: ((Reflection) => undefined | Type)
+
+

Type declaration

+
    +
  • +
      +
    • (Reflection): undefined | Type
    • +
    • +
      +

      Parameters

      +
        +
      • +
        Reflection: DeclarationReflection
      +

      Returns undefined | Type

+
+ +
buildUrls: ((Reflection, URLs) => UrlMapping<any>[])
+
+

Type declaration

+
    +
  • +
      +
    • (Reflection, URLs): UrlMapping<any>[]
    • +
    • +
      +

      Parameters

      +
        +
      • +
        Reflection: DeclarationReflection
      • +
      • +
        URLs: UrlMapping<any>[]
        +

        rome-ignore lint/suspicious/noExplicitAny:

        +
        +
      +

      Returns UrlMapping<any>[]

+
+ +
getRenderContext: ((Event) => Type)
+
+

Type declaration

+
    +
  • +
      +
    • (Event): Type
    • +
    • +
      +

      Parameters

      +
        +
      • +
        Event: PageEvent<Reflection>
      +

      Returns Type

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/TypeDoc.Type.html b/Documentation/Interface/TypeDoc.Type.html new file mode 100644 index 00000000..00340ae1 --- /dev/null +++ b/Documentation/Interface/TypeDoc.Type.html @@ -0,0 +1,96 @@ +Type | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
Directory: string
+

The name of the directory the output files should be written to.

+
+
+
+ +
Kind: ReflectionKind[]
+

DeclarationReflection.kind this rule applies to.

+
+
+
+ +
Template: RenderTemplate<PageEvent<any>>
+

rome-ignore lint/suspicious/noExplicitAny:

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Build.html b/Documentation/Module/Build.html new file mode 100644 index 00000000..76835307 --- /dev/null +++ b/Documentation/Module/Build.html @@ -0,0 +1,66 @@ +Build | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module Build

+
+
+

Index

+
+

Interfaces

+
+
+

Variables

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/ESBuild.html b/Documentation/Module/ESBuild.html new file mode 100644 index 00000000..59da8bd4 --- /dev/null +++ b/Documentation/Module/ESBuild.html @@ -0,0 +1,54 @@ +ESBuild | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module ESBuild

+
+
+

Index

+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Exec.html b/Documentation/Module/Exec.html new file mode 100644 index 00000000..557c517d --- /dev/null +++ b/Documentation/Module/Exec.html @@ -0,0 +1,58 @@ +Exec | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module Exec

+
+
+

Index

+
+

Interfaces

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/File.html b/Documentation/Module/File.html new file mode 100644 index 00000000..b9b65ff5 --- /dev/null +++ b/Documentation/Module/File.html @@ -0,0 +1,58 @@ +File | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module File

+
+
+

Index

+
+

Interfaces

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/JSON.html b/Documentation/Module/JSON.html new file mode 100644 index 00000000..57485d7e --- /dev/null +++ b/Documentation/Module/JSON.html @@ -0,0 +1,58 @@ +JSON | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module JSON

+
+
+

Index

+
+

Interfaces

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/TypeDoc.html b/Documentation/Module/TypeDoc.html new file mode 100644 index 00000000..b7f47b35 --- /dev/null +++ b/Documentation/Module/TypeDoc.html @@ -0,0 +1,75 @@ +TypeDoc | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module TypeDoc

+
+

Defines a mapping of a Models.Kind to a template file.

+

Used by DefaultTheme to map reflections to output files.

+
+
+
+
+

Index

+
+

Classes

+
+
+

Interfaces

+
+
+

Variables

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/TypeScriptESBuild.html b/Documentation/Module/TypeScriptESBuild.html new file mode 100644 index 00000000..356285c5 --- /dev/null +++ b/Documentation/Module/TypeScriptESBuild.html @@ -0,0 +1,54 @@ +TypeScriptESBuild | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Module TypeScriptESBuild

+
+
+

Index

+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/Build.Current.html b/Documentation/Variable/Build.Current.html new file mode 100644 index 00000000..d4ffc37a --- /dev/null +++ b/Documentation/Variable/Build.Current.html @@ -0,0 +1,49 @@ +Current | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Variable CurrentConst

+
Current: string = ...
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/Build.Pipe.html b/Documentation/Variable/Build.Pipe.html new file mode 100644 index 00000000..09d33e2c --- /dev/null +++ b/Documentation/Variable/Build.Pipe.html @@ -0,0 +1,49 @@ +Pipe | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Variable PipeConst

+
Pipe: string[] = []
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/ESBuild.ESBuild.html b/Documentation/Variable/ESBuild.ESBuild.html new file mode 100644 index 00000000..72ebaa20 --- /dev/null +++ b/Documentation/Variable/ESBuild.ESBuild.html @@ -0,0 +1,49 @@ +ESBuild | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Variable ESBuild

+
ESBuild: BuildOptions
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/TypeDoc._Context.html b/Documentation/Variable/TypeDoc._Context.html new file mode 100644 index 00000000..b4bcdcdb --- /dev/null +++ b/Documentation/Variable/TypeDoc._Context.html @@ -0,0 +1,49 @@ +_Context | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Variable _Context

+
_Context: typeof TypeDoc
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/TypeScriptESBuild.TypeScriptESBuild.html b/Documentation/Variable/TypeScriptESBuild.TypeScriptESBuild.html new file mode 100644 index 00000000..5e8ffbc0 --- /dev/null +++ b/Documentation/Variable/TypeScriptESBuild.TypeScriptESBuild.html @@ -0,0 +1,49 @@ +TypeScriptESBuild | typescript-esbuild - v0.2.4
+
+ +
+
+
+
+ +

Variable TypeScriptESBuild

+
TypeScriptESBuild: Command
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/assets/custom.css b/Documentation/assets/custom.css new file mode 100644 index 00000000..d43ae601 --- /dev/null +++ b/Documentation/assets/custom.css @@ -0,0 +1,14 @@ +:root { + --color-background: #000; + --color-background-secondary: #000; +} + +.tsd-navigation.settings { + display: none !important; +} + +#tsd-search .field label { + left: 50%; + margin-left: -20px; + z-index: 1; +} diff --git a/Documentation/assets/highlight.css b/Documentation/assets/highlight.css new file mode 100644 index 00000000..a99bf376 --- /dev/null +++ b/Documentation/assets/highlight.css @@ -0,0 +1,57 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #0451A5; + --dark-hl-4: #9CDCFE; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +pre, code { background: var(--code-background); } diff --git a/Documentation/assets/main.js b/Documentation/assets/main.js new file mode 100644 index 00000000..01bcad55 --- /dev/null +++ b/Documentation/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/Documentation/assets/navigation.js b/Documentation/assets/navigation.js new file mode 100644 index 00000000..4d5db794 --- /dev/null +++ b/Documentation/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACqWU206EMBCG36XXqFlWN4ZL0U008ZBgvNkQ04Uqjd1CSjFrjO8ubaBb6AF072Cm/zd/p5PZfAOO9hxE4KrBJAcBqCAv2t/7Mm8IOpPR04LvSJv6wDQHURiArGijDFEQbZT++atCB/kt5Yi9wawniOwIc7H6CZQ6bljL4wfAC2QYbpWDLj9ELEON8IT1+iO5SHq0o7uvG5pxXNJObOnB6lxT3+xR5hSLpEebI1TtEHtHToA64aEwVJfk083o8gYh1W+R2Cegi8+aAYOhnqGnWGntW6TOfvY2jD7+cQ4lYGoMHU8ptdaX1H2vMUGGbxE8yrcETPkella+pdZ0MPJ9lzw+GL5F8CjfEjDle1ha+ZZa08HIt4Bfl+aodPHZ7geMmMC6VggrahFe+lxYCSeLKYathzrE18Y5+rGDfxDCowlLH+E1Lqn8NNdHD+mPeHY5KaFtlfcEkZ6cqiRjuOKujWicmD1pDu7gmkPyRC25OdNfQfTABcUHAAA=" \ No newline at end of file diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js new file mode 100644 index 00000000..535a7731 --- /dev/null +++ b/Documentation/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACq1a23KbSBD9F/xKFM0FEH5cJ6nKbmV3a53Ni8qlkqWxQxaBCqGsUyr/e2aGAabRNBcpT5TE6dM9fbrbjfDJK/L/D97t8uT9l2Rb75b6XrbeCe/W+/xjL+43RbIv39//dkzSred7xyKVdz7l22Mq3p4BZl/LXSpRm3R9OAjJ6nmvfk3MxjB/WRfJ+tHJPcab7+3XhchKp482lDYS57mGzxLyhuH9i9g0BB+O2aZM8sxQqHv9UXYjs4i3Qux3ongWGHsDuNhFIQ55+h11YG5Po7dk/jvZi3NlK25172Liu2OhQQi3uX1xWmBRdJIyovTwcgPFYqoNKZIJxaYZhmtNG7ui+pCkohuV+m5sVMC+iUozIDRWVNrYFdXv93/92Y1KfTc2KmDfRKUZEBorKm1sRRWEYHg1vB+zUhRP601deurmxOIYptbSDjN39R0m1uoME3clGibWCR4m7mYZ0L7Lz1rFfN1bASOiq2mGA6zjaOnJnLYl9of6agT/jQH2OtFwzNO7pBCbMi9+jHJnoy/3+Vns9um6HJXBGws8yeNEud6QqwRL8/WQYMbDjYFOOkwYBKw9zmpVjj6QdjdrLIa9znR8zr8x7mVt4oqGLmY1z6gl7Hz1InSBdvmd4gDZcTd7r94BaQ+xybNDWRxVK4xwcgPhwxpAx3TO26MlWVKOcWlwU31ZQq3ucllYL45lqDavEZM7Z6pU05sT5OxZlP+IbCuK7on6nN04rK5S7lEV7L9Fehjn3oZf5Xf1ab3fJ9nzOLcWeqpXMBAnOb3c59QpT6+a8qD5ej2M778rp7zlzkz5NzQcN+h1iJenkl2VSrQne71d1pRXphhxXaebj8v2WeRIYs7HRH9Y0+bEr0lF47MpuXE5aGNFDn82q/rjmDSsfs3Ra5eTVqomzpHDsj+ESw+NbKvNE2xtpzfGcb394MuZuBUv3u3J+y6Kg6SRt+mMzWKJf0pEulU/AVZ+JVu+2ymGB3Pvi36YUIgK8nbu+cu5z+YzEgQPD/6yttA39BcaRjAYATBZlUviglEAY/IT9Wk4i2ICYAzAZJ8vmc+CGQ05gHEAC+Qn7oIFACZn9DJwwUIAi+Sn0AWLAGyBnXQBYDF20himd47hSEcHle/IKQRUglAUCLUgKucLJxCqQTgKhHoQlffYJ9EsJgsIhIqQEAVCTUiEAqEqZIECoS5E5Z/MnRmH0tA5RkmhNFQJQIirdGinS3SbUCcSikOVBMTZAxSqQzkaJlSHKg0IdzYplEdtNUsS+JTOaARzRKE+VKlAQicnFIgucCRUiOIKUagQUzqQyJUkBiViWiJnDTMoEdMSxU7OzixjaJwMSsSUENQ5RRnUiCkhqHO8MKgRU0JQ6kRCjZgSgjInEmrE0CZiUCIW4+mEEvE5WkocSsQJ5pxDhThFs8mhQpzhzjt/cDiadw4V4gHOCRXiuEIcKsQjnBMqxBeolhxKxGO023klkV4o5CZRiu3HarGQq0G9ap28ldk2ZFxmlzl5svtvT6++J6WrrsxcA3ON1PW13T7UJ+V6tamfISziuCWWrYUY7uoNrDWk1DKsIwoRgsfqFzDLrXWcynbRZ3rU677l3LJn9bE5wgB+jLJCiCyOOWZbvx9r7cLWDEu09cKxtWOtHRbptv212YrTSjTFFBKH8xRbgdKoyhHFsiz06zArwVZuKtO4uhAsU0/61VXLYGVX7kaVLRa9fFQs9KOio0DljGlD4UZqjKj6EcLKwcIyNlGwGDH+dpDLvGVs2RKTBIIpp584bMd2gRPEqHoqsYy4ZVRXNRatqyWtEmNGcY4pvk/ghLEGDNbFzUvu1sqKOECsyuZ9hnVSK1LKMMPODLQmFTHZIWbwEHNasjB1bkYjNQXDzPcck0L52uagBYhVeMRUPzVX1hfzQf+vhKMjLUITnzMc+SdBiZMmmYQuH15ffwIZC+DSWiIAAA=="; \ No newline at end of file diff --git a/Documentation/assets/style.css b/Documentation/assets/style.css new file mode 100644 index 00000000..108428c3 --- /dev/null +++ b/Documentation/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/Documentation/index.html b/Documentation/index.html new file mode 100644 index 00000000..bec53ea0 --- /dev/null +++ b/Documentation/index.html @@ -0,0 +1,73 @@ +typescript-esbuild - v0.2.4
+
+ +
+
+
+
+

typescript-esbuild - v0.2.4

+

TypeScriptESBuild 🌀

Builds all your TypeScript files into JavaScript.

+

Installation

Add configuration and setup scripts:

+
npm install -D -E typescript-esbuild
+
+

Usage

package.json

+
{
"name": "package",
"scripts": {
"prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts'"
},
"devDependencies": {
"typescript-esbuild": "0.2.4"
}
} +
+

ESBuild Configuration

Or with a custom esbuild config file:

+
{
"scripts": {
"prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts' -es ESBuild.ts"
}
} +
+

TypeScript Configuration

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

+
\ No newline at end of file diff --git a/Source/Interface/Mapping.ts b/Source/Interface/Mapping.ts index fe54d21a..2805e9b8 100644 --- a/Source/Interface/Mapping.ts +++ b/Source/Interface/Mapping.ts @@ -2,6 +2,9 @@ * Defines a mapping of a {@link Models.Kind} to a template file. * * Used by {@link DefaultTheme} to map reflections to output files. + * + * @module TypeDoc + * */ export default interface Type { /** diff --git a/Source/Interface/TypeDoc/Context.ts b/Source/Interface/TypeDoc/Context.ts index b219893b..56a44076 100644 --- a/Source/Interface/TypeDoc/Context.ts +++ b/Source/Interface/TypeDoc/Context.ts @@ -1,3 +1,7 @@ +/** + * @module TypeDoc + * + */ export default interface Type extends DefaultThemeRenderContext { init: () => void; } diff --git a/Target/Class/TypeDoc/Theme.d.ts b/Target/Class/TypeDoc/Theme.d.ts new file mode 100644 index 00000000..ccbdc1e2 --- /dev/null +++ b/Target/Class/TypeDoc/Theme.d.ts @@ -0,0 +1,17 @@ +declare const default_base: typeof DefaultTheme; +/** + * @module TypeDoc + * + */ +export default class extends default_base implements Type { + getRenderContext: (Event: import("typedoc").PageEvent) => Context; + buildUrls(...[Reflection, URLs]: Parameters): UrlMapping[]; + _Mapping: (Reflection: DeclarationReflection) => Mapping | undefined; + Mapping: Mapping[]; +} +import type Mapping from "../../Interface/Mapping.js"; +import type Context from "../../Interface/TypeDoc/Context.js"; +import type Type from "../../Interface/TypeDoc/Theme.js"; +import { DeclarationReflection, DefaultTheme, UrlMapping } from "typedoc"; +export declare const _Context: typeof import("./Context.js").default; +export {}; diff --git a/Target/Class/TypeDoc/Theme.js b/Target/Class/TypeDoc/Theme.js index 3448758e..8bb39351 100644 --- a/Target/Class/TypeDoc/Theme.js +++ b/Target/Class/TypeDoc/Theme.js @@ -1 +1 @@ -class m extends(await import("typedoc")).DefaultTheme{getRenderContext=(...[e])=>new s(this,e,this.application.options);buildUrls(...[e,i]){const{Directory:p,Template:n}=this._Mapping(e)??{};if(p&&n){if(!e.url||!a.URL_PREFIX.test(e.url)){const r=[p,`${a.getUrl(e)}.html`].join("/");i.push(new o(r,e,n)),e.url=r,e.hasOwnDocument=!0}e.traverse(r=>(r instanceof l?this.buildUrls(r,i):a.applyAnchorUrl(r,e),!0))}else e.parent&&a.applyAnchorUrl(e,e.parent);return i}_Mapping=(...[e])=>this.Mapping.find(i=>e.kindOf(i.Kind));Mapping=[{Kind:[t.Class],Directory:"Class",Template:this.reflectionTemplate},{Kind:[t.Interface],Directory:"Interface",Template:this.reflectionTemplate},{Kind:[t.Enum],Directory:"Enum",Template:this.reflectionTemplate},{Kind:[t.Namespace,t.Module],Directory:"Module",Template:this.reflectionTemplate},{Kind:[t.TypeAlias],Directory:"Type",Template:this.reflectionTemplate},{Kind:[t.Function],Directory:"Function",Template:this.reflectionTemplate},{Kind:[t.Variable],Directory:"Variable",Template:this.reflectionTemplate}]}import{DeclarationReflection as l,DefaultTheme as a,ReflectionKind as t,UrlMapping as o}from"typedoc";const{default:s}=await import("./Context.js");export{s as _Context,m as default}; +class m extends(await import("typedoc")).DefaultTheme{getRenderContext=(...[e])=>new s(this,e,this.application.options);buildUrls(...[e,i]){const{Directory:a,Template:n}=this._Mapping(e)??{};if(a&&n){if(!e.url||!p.URL_PREFIX.test(e.url)){const r=[a,`${p.getUrl(e)}.html`].join("/");i.push(new o(r,e,n)),e.url=r,e.hasOwnDocument=!0}e.traverse(r=>(r instanceof l?this.buildUrls(r,i):p.applyAnchorUrl(r,e),!0))}else e.parent&&p.applyAnchorUrl(e,e.parent);return i}_Mapping=(...[e])=>this.Mapping.find(i=>e.kindOf(i.Kind));Mapping=[{Kind:[t.Class],Directory:"Class",Template:this.reflectionTemplate},{Kind:[t.Interface],Directory:"Interface",Template:this.reflectionTemplate},{Kind:[t.Enum],Directory:"Enum",Template:this.reflectionTemplate},{Kind:[t.Namespace,t.Module],Directory:"Module",Template:this.reflectionTemplate},{Kind:[t.TypeAlias],Directory:"Type",Template:this.reflectionTemplate},{Kind:[t.Function],Directory:"Function",Template:this.reflectionTemplate},{Kind:[t.Variable],Directory:"Variable",Template:this.reflectionTemplate}]}import{DeclarationReflection as l,DefaultTheme as p,ReflectionKind as t,UrlMapping as o}from"typedoc";const{default:s}=await import("./Context.js");export{s as _Context,m as default}; diff --git a/Target/Interface/Mapping.d.ts b/Target/Interface/Mapping.d.ts index dfc5544d..90b52505 100644 --- a/Target/Interface/Mapping.d.ts +++ b/Target/Interface/Mapping.d.ts @@ -2,6 +2,9 @@ * Defines a mapping of a {@link Models.Kind} to a template file. * * Used by {@link DefaultTheme} to map reflections to output files. + * + * @module TypeDoc + * */ export default interface Type { /** diff --git a/Target/Interface/TypeDoc/Context.d.ts b/Target/Interface/TypeDoc/Context.d.ts index 161f891b..7d19480f 100644 --- a/Target/Interface/TypeDoc/Context.d.ts +++ b/Target/Interface/TypeDoc/Context.d.ts @@ -1,3 +1,7 @@ +/** + * @module TypeDoc + * + */ export default interface Type extends DefaultThemeRenderContext { init: () => void; } diff --git a/Target/Interface/TypeDoc/Theme.d.ts b/Target/Interface/TypeDoc/Theme.d.ts index 49affd34..272edaa1 100644 --- a/Target/Interface/TypeDoc/Theme.d.ts +++ b/Target/Interface/TypeDoc/Theme.d.ts @@ -5,7 +5,7 @@ export default interface Type { getRenderContext: (Event: PageEvent) => Context; buildUrls: (Reflection: DeclarationReflection, URLs: UrlMapping[]) => UrlMapping[]; - _Mapping: (Reflection: DeclarationReflection) => Mapping; + _Mapping: (Reflection: DeclarationReflection) => Mapping | undefined; Mapping: Mapping[]; } import type Mapping from "../Mapping.js";