From 8b29313ea6141da282b12bbb0b36c0597b6a935c Mon Sep 17 00:00:00 2001 From: "Nikola R. Hristov" Date: Mon, 1 Apr 2024 13:15:08 +0300 Subject: [PATCH] Document/v0.0.1 --- Documentation/classes/Theme.theme.html | 2 +- Documentation/functions/Document.Exec.html | 2 +- Documentation/functions/Document.document.html | 2 +- Documentation/functions/Document.resolve.html | 2 +- Documentation/functions/Exec.exec.html | 2 +- Documentation/functions/JSON.JSON.html | 2 +- Documentation/functions/Load.load-1.html | 2 +- Documentation/interfaces/Build.Type.html | 2 +- Documentation/interfaces/Exec.Type.html | 2 +- Documentation/interfaces/Interface_Mapping.Type.html | 6 +++--- Documentation/interfaces/Interface_Theme.Type.html | 8 ++++---- Documentation/interfaces/JSON.Type.html | 2 +- Documentation/interfaces/Load.Type.html | 4 ++-- Documentation/modules/Build.html | 2 +- Documentation/modules/Document.html | 2 +- Documentation/modules/Exec.html | 2 +- Documentation/modules/Interface_Mapping.html | 2 +- Documentation/modules/Interface_Theme.html | 2 +- Documentation/modules/JSON.html | 2 +- Documentation/modules/Load.html | 2 +- Documentation/modules/Theme.html | 2 +- Documentation/modules/TypeScriptDocument.html | 2 +- Documentation/variables/Document.Current.html | 2 +- Documentation/variables/Document.Pipe.html | 2 +- Documentation/variables/Load.Theme.html | 2 +- Documentation/variables/Load.load.html | 2 +- .../variables/TypeScriptDocument.typeScriptDocument.html | 2 +- 27 files changed, 33 insertions(+), 33 deletions(-) diff --git a/Documentation/classes/Theme.theme.html b/Documentation/classes/Theme.theme.html index 429e9ba..162bbe8 100644 --- a/Documentation/classes/Theme.theme.html +++ b/Documentation/classes/Theme.theme.html @@ -1,4 +1,4 @@ -theme | @playform/document - v0.0.1

Hierarchy

  • DefaultTheme
    • theme

Constructors

constructor +theme | @playform/document - v0.0.1

Hierarchy

  • DefaultTheme
    • theme

Constructors

Properties

componentName defaultLayoutTemplate hierarchyTemplate diff --git a/Documentation/functions/Document.Exec.html b/Documentation/functions/Document.Exec.html index e64eacc..8b4df32 100644 --- a/Documentation/functions/Document.Exec.html +++ b/Documentation/functions/Document.Exec.html @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

-

Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Document.document.html b/Documentation/functions/Document.document.html index cfa1cf5..8fa9132 100644 --- a/Documentation/functions/Document.document.html +++ b/Documentation/functions/Document.document.html @@ -3,4 +3,4 @@
  • Optional Option: {
        ESBuild?: string;
        TypeScript?: string;
    }

    An optional object that can contain two properties.

  • Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.resolve.html b/Documentation/functions/Document.resolve.html index 2be7221..7ba9a3b 100644 --- a/Documentation/functions/Document.resolve.html +++ b/Documentation/functions/Document.resolve.html @@ -6,4 +6,4 @@ and trailing slashes are removed unless the path gets resolved to the root directory.

    Parameters

    Returns string

    Throws

    if any of the arguments is not a string.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Exec.exec.html b/Documentation/functions/Exec.exec.html index 1af520a..45a1fb9 100644 --- a/Documentation/functions/Exec.exec.html +++ b/Documentation/functions/Exec.exec.html @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

    -

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/JSON.JSON.html b/Documentation/functions/JSON.JSON.html index f71b770..d4ec86e 100644 --- a/Documentation/functions/JSON.JSON.html +++ b/Documentation/functions/JSON.JSON.html @@ -6,4 +6,4 @@ 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 +

    Returns Promise<any>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Load.load-1.html b/Documentation/functions/Load.load-1.html index c35de8c..7f57a47 100644 --- a/Documentation/functions/Load.load-1.html +++ b/Documentation/functions/Load.load-1.html @@ -1 +1 @@ -load | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file +load | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Build.Type.html b/Documentation/interfaces/Build.Type.html index 80fe6e8..9629082 100644 --- a/Documentation/interfaces/Build.Type.html +++ b/Documentation/interfaces/Build.Type.html @@ -3,4 +3,4 @@
  • Optional Option: {
        ESBuild?: string;
        TypeScript?: string;
    }

    An optional object that can contain two properties.

  • Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Exec.Type.html b/Documentation/interfaces/Exec.Type.html index 9a92cfe..6b95bf5 100644 --- a/Documentation/interfaces/Exec.Type.html +++ b/Documentation/interfaces/Exec.Type.html @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

    -

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Interface_Mapping.Type.html b/Documentation/interfaces/Interface_Mapping.Type.html index 114c0e0..f6e46da 100644 --- a/Documentation/interfaces/Interface_Mapping.Type.html +++ b/Documentation/interfaces/Interface_Mapping.Type.html @@ -1,5 +1,5 @@ -Type | @playform/document - v0.0.1
    interface Type {
        Directory: string;
        Kind: ReflectionKind[];
    }

    Properties

    Directory +Type | @playform/document - v0.0.1
    interface Type {
        Directory: string;
        Kind: ReflectionKind[];
    }

    Properties

    Properties

    Directory: string

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

    -
    Kind: ReflectionKind[]

    DeclarationReflection.kind this rule applies to.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    Kind: ReflectionKind[]

    DeclarationReflection.kind this rule applies to.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Interface_Theme.Type.html b/Documentation/interfaces/Interface_Theme.Type.html index f5d7150..21f604b 100644 --- a/Documentation/interfaces/Interface_Theme.Type.html +++ b/Documentation/interfaces/Interface_Theme.Type.html @@ -1,4 +1,4 @@ -Type | @playform/document - v0.0.1
    interface Type {
        Mapping: Type[];
        _Mapping: ((Reflection) => undefined | Type);
        buildUrls: ((Reflection, URLs) => UrlMapping<any>[]);
        componentName: string;
        defaultLayoutTemplate: ((pageEvent, template) => JsxElement);
        hierarchyTemplate: ((pageEvent) => JsxElement);
        icons: {
            1: (() => JsxElement);
            1024: (() => JsxElement);
            1048576: (() => JsxElement);
            128: (() => JsxElement);
            131072: (() => JsxElement);
            16: (() => JsxElement);
            16384: (() => JsxElement);
            2: (() => JsxElement);
            2048: (() => JsxElement);
            2097152: (() => JsxElement);
            256: (() => JsxElement);
            262144: (() => JsxElement);
            32: (() => JsxElement);
            32768: (() => JsxElement);
            4: (() => JsxElement);
            4096: (() => JsxElement);
            4194304: (() => JsxElement);
            512: (() => JsxElement);
            524288: (() => JsxElement);
            64: (() => JsxElement);
            65536: (() => JsxElement);
            8: (() => JsxElement);
            8192: (() => JsxElement);
            anchor: (() => JsxElement);
            checkbox: (() => JsxElement);
            chevronDown: (() => JsxElement);
            chevronSmall: (() => JsxElement);
            menu: (() => JsxElement);
            search: (() => JsxElement);
        };
        indexTemplate: ((pageEvent) => JsxElement);
        markedPlugin: MarkedPlugin;
        reflectionTemplate: ((pageEvent) => JsxElement);
        get _listenId(): any;
        get application(): Application;
        get owner(): O;
        bubble(name, ...args): this;
        buildNavigation(project): NavigationElement[];
        getNavigation(project): NavigationElement[];
        getReflectionClasses(reflection): string;
        getRenderContext(pageEvent): DefaultThemeRenderContext;
        getUrls(project): UrlMapping<any>[];
        initialize(): void;
        listenTo(obj, name, callback?, priority?): this;
        listenToOnce(obj, eventMap): this;
        listenToOnce(obj, name, callback, priority?): this;
        off(): this;
        off(eventMap, context?): this;
        off(name, callback?, context?): this;
        on(eventMap, context?): this;
        on(eventMap, callback?, context?, priority?): this;
        on(name, callback, context?, priority?): this;
        once(eventMap, context?): this;
        once(name, callback, context?, priority?): this;
        render(page, template): string;
        stopListening(obj?, name?, callback?): this;
        trigger(name, ...args): this;
    }

    Hierarchy

    • DefaultTheme
      • Type

    Properties

    Mapping +Type | @playform/document - v0.0.1
    interface Type {
        Mapping: Type[];
        _Mapping: ((Reflection) => undefined | Type);
        buildUrls: ((Reflection, URLs) => UrlMapping<any>[]);
        componentName: string;
        defaultLayoutTemplate: ((pageEvent, template) => JsxElement);
        hierarchyTemplate: ((pageEvent) => JsxElement);
        icons: {
            1: (() => JsxElement);
            1024: (() => JsxElement);
            1048576: (() => JsxElement);
            128: (() => JsxElement);
            131072: (() => JsxElement);
            16: (() => JsxElement);
            16384: (() => JsxElement);
            2: (() => JsxElement);
            2048: (() => JsxElement);
            2097152: (() => JsxElement);
            256: (() => JsxElement);
            262144: (() => JsxElement);
            32: (() => JsxElement);
            32768: (() => JsxElement);
            4: (() => JsxElement);
            4096: (() => JsxElement);
            4194304: (() => JsxElement);
            512: (() => JsxElement);
            524288: (() => JsxElement);
            64: (() => JsxElement);
            65536: (() => JsxElement);
            8: (() => JsxElement);
            8192: (() => JsxElement);
            anchor: (() => JsxElement);
            checkbox: (() => JsxElement);
            chevronDown: (() => JsxElement);
            chevronSmall: (() => JsxElement);
            menu: (() => JsxElement);
            search: (() => JsxElement);
        };
        indexTemplate: ((pageEvent) => JsxElement);
        markedPlugin: MarkedPlugin;
        reflectionTemplate: ((pageEvent) => JsxElement);
        get _listenId(): any;
        get application(): Application;
        get owner(): O;
        bubble(name, ...args): this;
        buildNavigation(project): NavigationElement[];
        getNavigation(project): NavigationElement[];
        getReflectionClasses(reflection): string;
        getRenderContext(pageEvent): DefaultThemeRenderContext;
        getUrls(project): UrlMapping<any>[];
        initialize(): void;
        listenTo(obj, name, callback?, priority?): this;
        listenToOnce(obj, eventMap): this;
        listenToOnce(obj, name, callback, priority?): this;
        off(): this;
        off(eventMap, context?): this;
        off(name, callback?, context?): this;
        on(eventMap, context?): this;
        on(eventMap, callback?, context?, priority?): this;
        on(name, callback, context?, priority?): this;
        once(eventMap, context?): this;
        once(name, callback, context?, priority?): this;
        render(page, template): string;
        stopListening(obj?, name?, callback?): this;
        trigger(name, ...args): this;
    }

    Hierarchy

    • DefaultTheme
      • Type

    Properties

    Mapping: Type[]

    An array of Mappings representing the theme's mapping configuration.

    -
    _Mapping: ((Reflection) => undefined | Type)

    A function that maps a DeclarationReflection to a Mapping or returns undefined.

    +
    _Mapping: ((Reflection) => undefined | Type)

    A function that maps a DeclarationReflection to a Mapping or returns undefined.

    Type declaration

      • (Reflection): undefined | Type
      • Parameters

        • Reflection: DeclarationReflection

          The DeclarationReflection to map to a Mapping.

          -

        Returns undefined | Type

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

    A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.

    +

    Returns undefined | Type

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

    A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.

    Type declaration

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

        • Reflection: DeclarationReflection

          The DeclarationReflection for which URLs are being built.

        • URLs: UrlMapping<any>[]

          An array of URLs mappings with any data type.

          -

        Returns UrlMapping<any>[]

    componentName: string

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

    +

    Returns UrlMapping<any>[]

    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

    hierarchyTemplate: ((pageEvent) => JsxElement)

    Type declaration

      • (pageEvent): JsxElement
      • Parameters

        • pageEvent: PageEvent<ProjectReflection>

        Returns JsxElement

    icons: {
        1: (() => JsxElement);
        1024: (() => JsxElement);
        1048576: (() => JsxElement);
        128: (() => JsxElement);
        131072: (() => JsxElement);
        16: (() => JsxElement);
        16384: (() => JsxElement);
        2: (() => JsxElement);
        2048: (() => JsxElement);
        2097152: (() => JsxElement);
        256: (() => JsxElement);
        262144: (() => JsxElement);
        32: (() => JsxElement);
        32768: (() => JsxElement);
        4: (() => JsxElement);
        4096: (() => JsxElement);
        4194304: (() => JsxElement);
        512: (() => JsxElement);
        524288: (() => JsxElement);
        64: (() => JsxElement);
        65536: (() => JsxElement);
        8: (() => JsxElement);
        8192: (() => JsxElement);
        anchor: (() => JsxElement);
        checkbox: (() => JsxElement);
        chevronDown: (() => JsxElement);
        chevronSmall: (() => JsxElement);
        menu: (() => JsxElement);
        search: (() => JsxElement);
    }

    The icons which will actually be rendered. The source of truth lives on the theme, and the DefaultThemeRenderContext.icons member will produce references to these.

    These icons will be written twice. Once to an icons.svg file in the assets directory diff --git a/Documentation/interfaces/JSON.Type.html b/Documentation/interfaces/JSON.Type.html index 2fa3e8d..b005cdc 100644 --- a/Documentation/interfaces/JSON.Type.html +++ b/Documentation/interfaces/JSON.Type.html @@ -6,4 +6,4 @@ 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 +

    Returns Promise<any>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Load.Type.html b/Documentation/interfaces/Load.Type.html index 6ca10c5..5b8d8bf 100644 --- a/Documentation/interfaces/Load.Type.html +++ b/Documentation/interfaces/Load.Type.html @@ -1,5 +1,5 @@ -Type | @playform/document - v0.0.1
    interface Type {
        load: ((Application) => void);
    }

    Properties

    load +Type | @playform/document - v0.0.1
    interface Type {
        load: ((Application) => void);
    }

    Properties

    Properties

    load: ((Application) => void)

    The Load function is responsible for loading a plugin into the TypeDoc instance.

    Type declaration

      • (Application): void
      • Parameters

        • Application: Application

          The Application parameter is an instance of TypeDoc's Application class, representing the TypeDoc application to which the plugin should be loaded.

          -

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Build.html b/Documentation/modules/Build.html index a07412a..765d7a2 100644 --- a/Documentation/modules/Build.html +++ b/Documentation/modules/Build.html @@ -1,2 +1,2 @@ -Build | @playform/document - v0.0.1

    Index

    Interfaces

    Type +Build | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Document.html b/Documentation/modules/Document.html index dfd0a1b..080cf56 100644 --- a/Documentation/modules/Document.html +++ b/Documentation/modules/Document.html @@ -1,4 +1,4 @@ -Document | @playform/document - v0.0.1

    Index

    Variables

    Current +Document | @playform/document - v0.0.1

    Index

    Variables

    Functions

    Exec document diff --git a/Documentation/modules/Exec.html b/Documentation/modules/Exec.html index f35af07..76787d4 100644 --- a/Documentation/modules/Exec.html +++ b/Documentation/modules/Exec.html @@ -1,3 +1,3 @@ -Exec | @playform/document - v0.0.1

    Index

    Interfaces

    Type +Exec | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Interface_Mapping.html b/Documentation/modules/Interface_Mapping.html index 6712bd6..daa462f 100644 --- a/Documentation/modules/Interface_Mapping.html +++ b/Documentation/modules/Interface_Mapping.html @@ -1,2 +1,2 @@ -Interface/Mapping | @playform/document - v0.0.1

    Module Interface/Mapping

    Index

    Interfaces

    Type +Interface/Mapping | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Interface_Theme.html b/Documentation/modules/Interface_Theme.html index e726957..a2f1b53 100644 --- a/Documentation/modules/Interface_Theme.html +++ b/Documentation/modules/Interface_Theme.html @@ -1,2 +1,2 @@ -Interface/Theme | @playform/document - v0.0.1

    Module Interface/Theme

    Index

    Interfaces

    Type +Interface/Theme | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/JSON.html b/Documentation/modules/JSON.html index 73cedd6..4715f65 100644 --- a/Documentation/modules/JSON.html +++ b/Documentation/modules/JSON.html @@ -1,3 +1,3 @@ -JSON | @playform/document - v0.0.1

    Index

    Interfaces

    Type +JSON | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Load.html b/Documentation/modules/Load.html index 8f763b4..d241fe3 100644 --- a/Documentation/modules/Load.html +++ b/Documentation/modules/Load.html @@ -1,4 +1,4 @@ -Load | @playform/document - v0.0.1

    Index

    Interfaces

    Type +Load | @playform/document - v0.0.1

    Index

    Interfaces

    Variables

    Functions

    load diff --git a/Documentation/modules/Theme.html b/Documentation/modules/Theme.html index 726f00c..703658d 100644 --- a/Documentation/modules/Theme.html +++ b/Documentation/modules/Theme.html @@ -1,2 +1,2 @@ -Theme | @playform/document - v0.0.1

    Index

    Classes

    theme +Theme | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/TypeScriptDocument.html b/Documentation/modules/TypeScriptDocument.html index fbe1e08..0f4317f 100644 --- a/Documentation/modules/TypeScriptDocument.html +++ b/Documentation/modules/TypeScriptDocument.html @@ -1,2 +1,2 @@ -TypeScriptDocument | @playform/document - v0.0.1

    Module TypeScriptDocument

    Index

    Variables

    typeScriptDocument +TypeScriptDocument | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.Current.html b/Documentation/variables/Document.Current.html index 576d98e..fa294cf 100644 --- a/Documentation/variables/Document.Current.html +++ b/Documentation/variables/Document.Current.html @@ -1 +1 @@ -Current | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file +Current | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.Pipe.html b/Documentation/variables/Document.Pipe.html index 90a9a90..6556256 100644 --- a/Documentation/variables/Document.Pipe.html +++ b/Documentation/variables/Document.Pipe.html @@ -1 +1 @@ -Pipe | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file +Pipe | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Load.Theme.html b/Documentation/variables/Load.Theme.html index 3e37413..c74c38a 100644 --- a/Documentation/variables/Load.Theme.html +++ b/Documentation/variables/Load.Theme.html @@ -1 +1 @@ -Theme | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file +Theme | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Load.load.html b/Documentation/variables/Load.load.html index 43c6b25..f664ee5 100644 --- a/Documentation/variables/Load.load.html +++ b/Documentation/variables/Load.load.html @@ -1 +1 @@ -load | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file +load | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/TypeScriptDocument.typeScriptDocument.html b/Documentation/variables/TypeScriptDocument.typeScriptDocument.html index e680ee1..1b82bb3 100644 --- a/Documentation/variables/TypeScriptDocument.typeScriptDocument.html +++ b/Documentation/variables/TypeScriptDocument.typeScriptDocument.html @@ -1 +1 @@ -typeScriptDocument | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file +typeScriptDocument | @playform/document - v0.0.1

    Generated using TypeDoc

    \ No newline at end of file