From aa1c64a92762c6dbfd189a393e3c514d11b90c24 Mon Sep 17 00:00:00 2001 From: Nikola Hristov Date: Sat, 28 Oct 2023 01:40:19 +0300 Subject: [PATCH] squash! --- Documentation/Function/Image.Image-2.html | 66 + .../Function/Integration.Defaultsharp.html | 82 + .../Function/Integration.Integration.html | 61 + Documentation/Function/Integration.Merge.html | 69 + Documentation/Interface/CSS.Type-1.html | 239 +++ Documentation/Interface/CSS.Type.html | 268 ++++ Documentation/Interface/Image.Type-1.html | 121 ++ Documentation/Interface/Image.Type-2.html | 127 ++ Documentation/Interface/Image.Type.html | 70 + Documentation/Interface/Integration.Type.html | 65 + Documentation/Interface/Map.Type.html | 58 + Documentation/Interface/Option.Type.html | 243 +++ Documentation/Interface/Parser.Type.html | 107 ++ Documentation/Module/CSS.html | 63 + Documentation/Module/File.html | 61 + Documentation/Module/HTML.html | 61 + Documentation/Module/Image.html | 69 + Documentation/Module/Integration.html | 69 + Documentation/Module/JavaScript.html | 61 + Documentation/Module/Map.html | 61 + Documentation/Module/Option.html | 61 + Documentation/Module/Parser.html | 69 + Documentation/Module/SVG.html | 61 + Documentation/Type/File.Type.html | 52 + Documentation/Type/HTML.Type.html | 52 + Documentation/Type/JavaScript.Type.html | 52 + Documentation/Type/Parser.Type-1.html | 52 + Documentation/Type/Parser.Type-2.html | 52 + Documentation/Type/Parser.Type-3.html | 52 + Documentation/Type/Parser.Type-4.html | 52 + Documentation/Type/Parser.Type-5.html | 52 + Documentation/Type/SVG.Type.html | 52 + Documentation/Variable/CSS.CSS-1.html | 61 + Documentation/Variable/CSS.CSS.html | 57 + Documentation/Variable/File._Map.html | 77 + Documentation/Variable/HTML.HTML.html | 105 ++ Documentation/Variable/Image.Image-1.html | 77 + Documentation/Variable/Image.Image.html | 100 ++ Documentation/Variable/Image._Map.html | 77 + .../Variable/Integration.Default.html | 52 + .../Variable/Integration.Search.html | 52 + .../Variable/Integration._Action.html | 52 + .../Variable/JavaScript.JavaScript.html | 76 + Documentation/Variable/Map.Map.html | 65 + Documentation/Variable/Option.Option.html | 52 + Documentation/Variable/Parser.Parser.html | 65 + Documentation/Variable/SVG.SVG.html | 66 + Documentation/assets/highlight.css | 92 ++ Documentation/assets/main.js | 59 + Documentation/assets/style.css | 1383 +++++++++++++++++ Documentation/index.html | 173 +++ 51 files changed, 5421 insertions(+) create mode 100644 Documentation/Function/Image.Image-2.html create mode 100644 Documentation/Function/Integration.Defaultsharp.html create mode 100644 Documentation/Function/Integration.Integration.html create mode 100644 Documentation/Function/Integration.Merge.html create mode 100644 Documentation/Interface/CSS.Type-1.html create mode 100644 Documentation/Interface/CSS.Type.html create mode 100644 Documentation/Interface/Image.Type-1.html create mode 100644 Documentation/Interface/Image.Type-2.html create mode 100644 Documentation/Interface/Image.Type.html create mode 100644 Documentation/Interface/Integration.Type.html create mode 100644 Documentation/Interface/Map.Type.html create mode 100644 Documentation/Interface/Option.Type.html create mode 100644 Documentation/Interface/Parser.Type.html create mode 100644 Documentation/Module/CSS.html create mode 100644 Documentation/Module/File.html create mode 100644 Documentation/Module/HTML.html create mode 100644 Documentation/Module/Image.html create mode 100644 Documentation/Module/Integration.html create mode 100644 Documentation/Module/JavaScript.html create mode 100644 Documentation/Module/Map.html create mode 100644 Documentation/Module/Option.html create mode 100644 Documentation/Module/Parser.html create mode 100644 Documentation/Module/SVG.html create mode 100644 Documentation/Type/File.Type.html create mode 100644 Documentation/Type/HTML.Type.html create mode 100644 Documentation/Type/JavaScript.Type.html create mode 100644 Documentation/Type/Parser.Type-1.html create mode 100644 Documentation/Type/Parser.Type-2.html create mode 100644 Documentation/Type/Parser.Type-3.html create mode 100644 Documentation/Type/Parser.Type-4.html create mode 100644 Documentation/Type/Parser.Type-5.html create mode 100644 Documentation/Type/SVG.Type.html create mode 100644 Documentation/Variable/CSS.CSS-1.html create mode 100644 Documentation/Variable/CSS.CSS.html create mode 100644 Documentation/Variable/File._Map.html create mode 100644 Documentation/Variable/HTML.HTML.html create mode 100644 Documentation/Variable/Image.Image-1.html create mode 100644 Documentation/Variable/Image.Image.html create mode 100644 Documentation/Variable/Image._Map.html create mode 100644 Documentation/Variable/Integration.Default.html create mode 100644 Documentation/Variable/Integration.Search.html create mode 100644 Documentation/Variable/Integration._Action.html create mode 100644 Documentation/Variable/JavaScript.JavaScript.html create mode 100644 Documentation/Variable/Map.Map.html create mode 100644 Documentation/Variable/Option.Option.html create mode 100644 Documentation/Variable/Parser.Parser.html create mode 100644 Documentation/Variable/SVG.SVG.html create mode 100644 Documentation/assets/highlight.css create mode 100644 Documentation/assets/main.js create mode 100644 Documentation/assets/style.css create mode 100644 Documentation/index.html diff --git a/Documentation/Function/Image.Image-2.html b/Documentation/Function/Image.Image-2.html new file mode 100644 index 00000000..94059c70 --- /dev/null +++ b/Documentation/Function/Image.Image-2.html @@ -0,0 +1,66 @@ +Image | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Function Image

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Integration.Defaultsharp.html b/Documentation/Function/Integration.Defaultsharp.html new file mode 100644 index 00000000..237365d6 --- /dev/null +++ b/Documentation/Function/Integration.Defaultsharp.html @@ -0,0 +1,82 @@ +Defaultsharp | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Function Defaultsharp

+
+
    + +
  • +

    Creates a sharp instance from an image

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: SharpOptions
      +

      Object with optional attributes.

      +
      +
    +

    Returns sharp.Sharp

    A sharp instance that can be used to chain operations

    + +
    +

    Throws

    Invalid parameters

    +
  • + +
  • +
    +

    Parameters

    +
    +

    Returns sharp.Sharp

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Integration.Integration.html b/Documentation/Function/Integration.Integration.html new file mode 100644 index 00000000..6e2e910e --- /dev/null +++ b/Documentation/Function/Integration.Integration.html @@ -0,0 +1,61 @@ +Integration | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Function Integration

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Function/Integration.Merge.html b/Documentation/Function/Integration.Merge.html new file mode 100644 index 00000000..0b63ec81 --- /dev/null +++ b/Documentation/Function/Integration.Merge.html @@ -0,0 +1,69 @@ +Merge | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Function Merge

+
+
    + +
  • +

    Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      Ts extends readonly unknown[]

    +
    +

    Parameters

    +
      +
    • +
      Rest ...Objects: Ts
    +

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/CSS.Type-1.html b/Documentation/Interface/CSS.Type-1.html new file mode 100644 index 00000000..e3add389 --- /dev/null +++ b/Documentation/Interface/CSS.Type-1.html @@ -0,0 +1,239 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • MinifyOptions
  • +
  • CompressOptions +
      +
    • Type
+
+
+
+ +
+
+

Properties

+
+ +
afterCompress?: AfterCompressFn | AfterCompressFn[]
+

Called right after compress() is run.

+
+
+
+ +
beforeCompress?: BeforeCompressFn | BeforeCompressFn[]
+

Called right after parse is run.

+
+
+
+ +
clone?: boolean
+

Transform a copy of input AST if true. Useful in case of AST reuse.

+
+
+

Default

false
+
+
+
+ +
comments?: boolean
+

Specify what comments to leave:

+
    +
  • 'exclamation' or true – leave all exclamation comments
  • +
  • 'first-exclamation' – remove every comment except first one
  • +
  • false – remove all comments
  • +
+
+
+

Default

AstroCompress false
+
+ +

Default

csso true
+
+
+
+ +
debug?: boolean
+

Output debug information to stderr.

+
+
+

Default

false
+
+
+
+ +
filename?: string
+

Filename of input CSS, uses for source map generation.

+
+
+

Default

'<unknown>'
+
+
+
+ +
forceMediaMerge?: boolean
+

Enables merging of

+
+
+

Media

rules with the same media query by splitted by other rules. +The optimisation is unsafe in general, but should work fine in most cases. Use it on your own risk.

+ +

Default

AstroCompress true
+
+ +

Default

csso false
+
+
+
+ +
logger?: (() => void)
+
+

Type declaration

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

      Function to track every step of transformation.

      +
      +

      Returns void

      +
+
+ +
restructure?: boolean
+

Disable or enable a structure optimisations.

+
+
+

Default

AstroCompress false
+
+ +

Default

csso true
+
+
+
+ +
sourceMap?: boolean
+

Generate a source map when true.

+
+
+

Default

false
+
+
+
+ +
usage?: Usage
+

Usage data for advanced optimisations.

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/CSS.Type.html b/Documentation/Interface/CSS.Type.html new file mode 100644 index 00000000..0213a642 --- /dev/null +++ b/Documentation/Interface/CSS.Type.html @@ -0,0 +1,268 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Omit<TransformOptions<CustomAtRules>, "filename" | "code"> +
      +
    • Type
+
+
+
+ +
+
+

Properties

+
+ +
analyzeDependencies?: boolean | DependencyOptions
+

Whether to analyze dependencies (e.g. @import and url()). +When enabled, @import rules are removed, and url() dependencies +are replaced with hashed placeholders that can be replaced with the final +urls later (after bundling). Dependencies are returned as part of the result.

+
+
+
+ +
cssModules?: boolean | CSSModulesConfig
+

Whether to compile this file as a CSS module.

+
+
+
+ +
customAtRules?: CustomAtRules
+

Defines how to parse custom CSS at-rules. Each at-rule can have a prelude, defined using a CSS +syntax string, and +a block body. The body can be a declaration list, rule list, or style block as defined in the +css spec.

+
+
+
+ +
drafts?: Drafts
+

Whether to enable parsing various draft syntax.

+
+
+
+ +
errorRecovery?: boolean
+

Whether to ignore invalid rules and declarations rather than erroring. +When enabled, warnings are returned, and the invalid rule or declaration is +omitted from the output code.

+
+
+
+ +
exclude?: number
+

Features that should never be compiled, even when unsupported by targets.

+
+
+
+ +
include?: number
+

Features that should always be compiled, even when supported by targets.

+
+
+
+ +
inputSourceMap?: string
+

An input source map to extend.

+
+
+
+ +
minify?: boolean
+

Whether to enable minification

+
+
+

Default

AstroCompress true
+
+ +

Default

lightningcss false
+
+
+
+ +
nonStandard?: NonStandard
+

Whether to enable various non-standard syntax.

+
+
+
+ +
projectRoot?: string
+

An optional project root path, used as the source root in the output source map. +Also used to generate relative paths for sources used in CSS module hashes.

+
+
+
+ +
pseudoClasses?: PseudoClasses
+

Replaces user action pseudo classes with class names that can be applied from JavaScript. +This is useful for polyfills, for example.

+
+
+
+ +
sourceMap?: boolean
+

Whether to output a source map.

+
+
+
+ +
targets?: Targets
+

The browser targets for the generated code.

+
+
+
+ +
unusedSymbols?: string[]
+

A list of class names, ids, and custom identifiers (e.g. @keyframes) that are known +to be unused. These will be removed during minification. Note that these are not +selectors but individual names (without any . or # prefixes).

+
+
+
+ +
visitor?: Visitor<CustomAtRules>
+

An AST visitor object. This allows custom transforms or analysis to be implemented in JavaScript. +Multiple visitors can be composed into one using the composeVisitors function. +For optimal performance, visitors should be as specific as possible about what types of values +they care about so that JavaScript has to be called as little as possible.

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Image.Type-1.html b/Documentation/Interface/Image.Type-1.html new file mode 100644 index 00000000..ad18bab3 --- /dev/null +++ b/Documentation/Interface/Image.Type-1.html @@ -0,0 +1,121 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+

Indexable

+
[key: string]: undefined | boolean | AvifOptions | GifOptions | HeifOptions | JpegOptions | PngOptions | TiffOptions | WebpOptions
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
avif?: boolean | AvifOptions
+
+ +
gif?: boolean | GifOptions
+
+ +
heif?: boolean | HeifOptions
+
+ +
jpeg?: boolean | JpegOptions
+
+ +
png?: boolean | PngOptions
+
+ +
tiff?: boolean | TiffOptions
+
+ +
webp?: boolean | WebpOptions
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Image.Type-2.html b/Documentation/Interface/Image.Type-2.html new file mode 100644 index 00000000..d67b0fec --- /dev/null +++ b/Documentation/Interface/Image.Type-2.html @@ -0,0 +1,127 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Omit<File, "Buffer"> +
      +
    • Type
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
After: number
+

The size after the action.

+
+
+
+ +
Before: number
+

The size before the action.

+
+
+
+ +
Buffer: {
    [key: string]: any;
} & Sharp
+
+

Type declaration

+
    +
  • +
    [key: string]: any
+
+ +
Input: string
+

The input file.

+
+
+
+ +
Output: string
+

The output file.

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Image.Type.html b/Documentation/Interface/Image.Type.html new file mode 100644 index 00000000..03e9b9d9 --- /dev/null +++ b/Documentation/Interface/Image.Type.html @@ -0,0 +1,70 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Integration.Type.html b/Documentation/Interface/Integration.Type.html new file mode 100644 index 00000000..95aa8fa2 --- /dev/null +++ b/Documentation/Interface/Integration.Type.html @@ -0,0 +1,65 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Map.Type.html b/Documentation/Interface/Map.Type.html new file mode 100644 index 00000000..4aef2136 --- /dev/null +++ b/Documentation/Interface/Map.Type.html @@ -0,0 +1,58 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+

Indexable

+
[key: string]: string
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Option.Type.html b/Documentation/Interface/Option.Type.html new file mode 100644 index 00000000..61c47615 --- /dev/null +++ b/Documentation/Interface/Option.Type.html @@ -0,0 +1,243 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • default +
      +
    • Type
+
+
+
+ +
+
+

Properties

+
+ +
Action?: boolean | default
+

Action pipe configuration.

+
+
+
+ +
CSS?: boolean | {
    csso: Type;
    lightningcss: Type;
}
+

csso & lightningcss option properties

+
+
+

Type declaration

+
+
+
+ +
Cache?: boolean | default
+

Configuration for the target cache.

+
+
+

Default

{ Search: "./", Folder: "./Cache" }
+
+
+
+ +
Exclude?: boolean | Type | Type[] | Set<Type>
+

Criteria for excluding files.

+
+
+
+ +
Files?: string | boolean | string[]
+

File patterns to be matched.

+
+
+
+ +
HTML?: boolean | {
    html-minifier-terser: Options;
}
+

html-minifier-terser option properties

+
+
+

Type declaration

+
    +
  • +
    html-minifier-terser: Options
+
+
+ +
Image?: boolean | {
    sharp: Type;
}
+

sharp option properties

+
+
+

Type declaration

+
+
+
+ +
JavaScript?: boolean | {
    terser: MinifyOptions;
}
+

terser option properties

+
+
+

Type declaration

+
    +
  • +
    terser: MinifyOptions
+
+
+ +
Logger?: boolean | Type
+

Debugging level.

+
+
+

Default

2
+
+
+
+ +
Map?: boolean | Type
+

Map to different file paths

+
+
+
+ +
Parser?: Type
+

Parsers for different file types

+
+
+
+ +
Path?: boolean | Type | Type[] | Set<Type>
+

Configuration for the target path(s).

+
+
+

Default

"./Target"
+
+
+
+ +
SVG?: boolean | {
    svgo: Config;
}
+

svgo option properties

+
+
+

Type declaration

+
    +
  • +
    svgo: Config
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Interface/Parser.Type.html b/Documentation/Interface/Parser.Type.html new file mode 100644 index 00000000..55d3fb39 --- /dev/null +++ b/Documentation/Interface/Parser.Type.html @@ -0,0 +1,107 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Interface Type

+
+

Hierarchy

+
    +
  • Type
+
+

Indexable

+
[key: string]: any
+
+
+
+ +
+
+

Properties

+
+
+

Properties

+
+ +
CSS?: Type | Type[]
+
+ +
HTML?: "html-minifier-terser" | "html-minifier-terser"[]
+
+ +
Image?: "sharp" | "sharp"[]
+
+ +
JavaScript?: "terser" | "terser"[]
+
+ +
SVG?: "svgo" | "svgo"[]
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/CSS.html b/Documentation/Module/CSS.html new file mode 100644 index 00000000..d864ac59 --- /dev/null +++ b/Documentation/Module/CSS.html @@ -0,0 +1,63 @@ +CSS | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module CSS

+
+
+

Index

+
+

Interfaces

+
+
+

Variables

+
CSS +CSS +
+
+ +
+
+

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..470cde33 --- /dev/null +++ b/Documentation/Module/File.html @@ -0,0 +1,61 @@ +File | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module File

+
+
+

Index

+
+

Type Aliases

+
+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/HTML.html b/Documentation/Module/HTML.html new file mode 100644 index 00000000..5279dfe0 --- /dev/null +++ b/Documentation/Module/HTML.html @@ -0,0 +1,61 @@ +HTML | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module HTML

+
+
+

Index

+
+

Type Aliases

+
+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Image.html b/Documentation/Module/Image.html new file mode 100644 index 00000000..361fcc5b --- /dev/null +++ b/Documentation/Module/Image.html @@ -0,0 +1,69 @@ +Image | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module Image

+
+
+

Index

+
+

Interfaces

+
+
+

Variables

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Integration.html b/Documentation/Module/Integration.html new file mode 100644 index 00000000..d09eaa53 --- /dev/null +++ b/Documentation/Module/Integration.html @@ -0,0 +1,69 @@ +Integration | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module Integration

+
+
+

Index

+
+

Interfaces

+
+
+

Variables

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/JavaScript.html b/Documentation/Module/JavaScript.html new file mode 100644 index 00000000..184425aa --- /dev/null +++ b/Documentation/Module/JavaScript.html @@ -0,0 +1,61 @@ +JavaScript | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module JavaScript

+
+
+

Index

+
+

Type Aliases

+
+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Map.html b/Documentation/Module/Map.html new file mode 100644 index 00000000..9649b5a4 --- /dev/null +++ b/Documentation/Module/Map.html @@ -0,0 +1,61 @@ +Map | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module Map

+
+
+

Index

+
+

Interfaces

+
+
+

Variables

+
Map +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Option.html b/Documentation/Module/Option.html new file mode 100644 index 00000000..aea2ded1 --- /dev/null +++ b/Documentation/Module/Option.html @@ -0,0 +1,61 @@ +Option | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module Option

+
+
+

Index

+
+

Interfaces

+
+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/Parser.html b/Documentation/Module/Parser.html new file mode 100644 index 00000000..812e4e7b --- /dev/null +++ b/Documentation/Module/Parser.html @@ -0,0 +1,69 @@ +Parser | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module Parser

+
+
+

Index

+
+

Interfaces

+
+
+

Type Aliases

+
+
+

Variables

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Module/SVG.html b/Documentation/Module/SVG.html new file mode 100644 index 00000000..2802a349 --- /dev/null +++ b/Documentation/Module/SVG.html @@ -0,0 +1,61 @@ +SVG | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Module SVG

+
+
+

Index

+
+

Type Aliases

+
+
+

Variables

+
SVG +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/File.Type.html b/Documentation/Type/File.Type.html new file mode 100644 index 00000000..d8d8481f --- /dev/null +++ b/Documentation/Type/File.Type.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/HTML.Type.html b/Documentation/Type/HTML.Type.html new file mode 100644 index 00000000..abc40582 --- /dev/null +++ b/Documentation/Type/HTML.Type.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/JavaScript.Type.html b/Documentation/Type/JavaScript.Type.html new file mode 100644 index 00000000..f5312eb2 --- /dev/null +++ b/Documentation/Type/JavaScript.Type.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/Parser.Type-1.html b/Documentation/Type/Parser.Type-1.html new file mode 100644 index 00000000..29b381f6 --- /dev/null +++ b/Documentation/Type/Parser.Type-1.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/Parser.Type-2.html b/Documentation/Type/Parser.Type-2.html new file mode 100644 index 00000000..0d5d0810 --- /dev/null +++ b/Documentation/Type/Parser.Type-2.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/Parser.Type-3.html b/Documentation/Type/Parser.Type-3.html new file mode 100644 index 00000000..86d14b73 --- /dev/null +++ b/Documentation/Type/Parser.Type-3.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/Parser.Type-4.html b/Documentation/Type/Parser.Type-4.html new file mode 100644 index 00000000..77db6bf3 --- /dev/null +++ b/Documentation/Type/Parser.Type-4.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Type alias Type

+
Type: "html-minifier-terser"
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/Parser.Type-5.html b/Documentation/Type/Parser.Type-5.html new file mode 100644 index 00000000..d4c08ec7 --- /dev/null +++ b/Documentation/Type/Parser.Type-5.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Type alias Type

+
Type: "csso" | "lightningcss"
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Type/SVG.Type.html b/Documentation/Type/SVG.Type.html new file mode 100644 index 00000000..874a847c --- /dev/null +++ b/Documentation/Type/SVG.Type.html @@ -0,0 +1,52 @@ +Type | astro-compress - v2.1.6
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/CSS.CSS-1.html b/Documentation/Variable/CSS.CSS-1.html new file mode 100644 index 00000000..28ef2a1e --- /dev/null +++ b/Documentation/Variable/CSS.CSS-1.html @@ -0,0 +1,61 @@ +CSS | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Variable CSS

+
CSS: {
    comments: false;
    forceMediaMerge: true;
    restructure: false;
}
+
+

Type declaration

+
    +
  • +
    comments: false
  • +
  • +
    forceMediaMerge: true
  • +
  • +
    restructure: false
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/CSS.CSS.html b/Documentation/Variable/CSS.CSS.html new file mode 100644 index 00000000..cd3339ba --- /dev/null +++ b/Documentation/Variable/CSS.CSS.html @@ -0,0 +1,57 @@ +CSS | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Variable CSS

+
CSS: {
    minify: true;
}
+
+

Type declaration

+
    +
  • +
    minify: true
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/File._Map.html b/Documentation/Variable/File._Map.html new file mode 100644 index 00000000..5a6af22c --- /dev/null +++ b/Documentation/Variable/File._Map.html @@ -0,0 +1,77 @@ +_Map | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Variable _Map

+
_Map: {
    apng: string;
    avci: string;
    avcs: string;
    avifs: string;
    heic: string;
    heics: string;
    heifs: string;
    jfif: string;
    jif: string;
    jpe: string;
    jpg: string;
}
+
+

Type declaration

+
    +
  • +
    apng: string
  • +
  • +
    avci: string
  • +
  • +
    avcs: string
  • +
  • +
    avifs: string
  • +
  • +
    heic: string
  • +
  • +
    heics: string
  • +
  • +
    heifs: string
  • +
  • +
    jfif: string
  • +
  • +
    jif: string
  • +
  • +
    jpe: string
  • +
  • +
    jpg: string
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/HTML.HTML.html b/Documentation/Variable/HTML.HTML.html new file mode 100644 index 00000000..91461709 --- /dev/null +++ b/Documentation/Variable/HTML.HTML.html @@ -0,0 +1,105 @@ +HTML | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Variable HTML

+
HTML: {
    caseSensitive: true;
    collapseInlineTagWhitespace: false;
    collapseWhitespace: true;
    continueOnParseError: true;
    html5: true;
    ignoreCustomComments: RegExp[];
    includeAutoGeneratedTags: true;
    keepClosingSlash: true;
    minifyCSS: true;
    minifyJS: true;
    minifyURLs: false;
    noNewlinesBeforeTagClose: true;
    preventAttributesEscaping: false;
    processConditionalComments: false;
    processScripts: string[];
    quoteCharacter: string;
    removeAttributeQuotes: true;
    removeComments: true;
    removeScriptTypeAttributes: true;
    removeStyleLinkTypeAttributes: true;
    removeTagWhitespace: false;
    sortAttributes: true;
    sortClassName: true;
    trimCustomFragments: true;
    useShortDoctype: false;
}
+
+

Type declaration

+
    +
  • +
    caseSensitive: true
  • +
  • +
    collapseInlineTagWhitespace: false
  • +
  • +
    collapseWhitespace: true
  • +
  • +
    continueOnParseError: true
  • +
  • +
    html5: true
  • +
  • +
    ignoreCustomComments: RegExp[]
  • +
  • +
    includeAutoGeneratedTags: true
  • +
  • +
    keepClosingSlash: true
  • +
  • +
    minifyCSS: true
  • +
  • +
    minifyJS: true
  • +
  • +
    minifyURLs: false
  • +
  • +
    noNewlinesBeforeTagClose: true
  • +
  • +
    preventAttributesEscaping: false
  • +
  • +
    processConditionalComments: false
  • +
  • +
    processScripts: string[]
  • +
  • +
    quoteCharacter: string
  • +
  • +
    removeAttributeQuotes: true
  • +
  • +
    removeComments: true
  • +
  • +
    removeScriptTypeAttributes: true
  • +
  • +
    removeStyleLinkTypeAttributes: true
  • +
  • +
    removeTagWhitespace: false
  • +
  • +
    sortAttributes: true
  • +
  • +
    sortClassName: true
  • +
  • +
    trimCustomFragments: true
  • +
  • +
    useShortDoctype: false
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/Image.Image-1.html b/Documentation/Variable/Image.Image-1.html new file mode 100644 index 00000000..60e69e5a --- /dev/null +++ b/Documentation/Variable/Image.Image-1.html @@ -0,0 +1,77 @@ +Image | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Variable Image

+
Image: {
    apng: string;
    avci: string;
    avcs: string;
    avifs: string;
    heic: string;
    heics: string;
    heifs: string;
    jfif: string;
    jif: string;
    jpe: string;
    jpg: string;
}
+
+

Type declaration

+
    +
  • +
    apng: string
  • +
  • +
    avci: string
  • +
  • +
    avcs: string
  • +
  • +
    avifs: string
  • +
  • +
    heic: string
  • +
  • +
    heics: string
  • +
  • +
    heifs: string
  • +
  • +
    jfif: string
  • +
  • +
    jif: string
  • +
  • +
    jpe: string
  • +
  • +
    jpg: string
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/Variable/Image.Image.html b/Documentation/Variable/Image.Image.html new file mode 100644 index 00000000..a599beea --- /dev/null +++ b/Documentation/Variable/Image.Image.html @@ -0,0 +1,100 @@ +Image | astro-compress - v2.1.6
+
+ +
+
+
+
+ +

Variable Image

+
Image: {
    avif: {
        chromaSubsampling: string;
        effort: number;
    };
    gif: {
        effort: number;
    };
    jpeg: {
        chromaSubsampling: string;
        mozjpeg: true;
        optimiseScans: true;
        overshootDeringing: true;
        trellisQuantisation: true;
    };
    png: {
        compressionLevel: number;
        palette: true;
    };
    raw: {};
    tiff: {
        compression: string;
    };
    webp: {
        effort: number;
    };
}
+
+

Type declaration

+
    +
  • +
    avif: {
        chromaSubsampling: string;
        effort: number;
    }
    +
      +
    • +
      chromaSubsampling: string
    • +
    • +
      effort: number
  • +
  • +
    gif: {
        effort: number;
    }
    +
      +
    • +
      effort: number
  • +
  • +
    jpeg: {
        chromaSubsampling: string;
        mozjpeg: true;
        optimiseScans: true;
        overshootDeringing: true;
        trellisQuantisation: true;
    }
    +
      +
    • +
      chromaSubsampling: string
    • +
    • +
      mozjpeg: true
    • +
    • +
      optimiseScans: true
    • +
    • +
      overshootDeringing: true
    • +
    • +
      trellisQuantisation: true
  • +
  • +
    png: {
        compressionLevel: number;
        palette: true;
    }
    +
      +
    • +
      compressionLevel: number
    • +
    • +
      palette: true
  • +
  • +
    raw: {}
    +
    • +
    • +
      tiff: {
          compression: string;
      }
      +
        +
      • +
        compression: string
    • +
    • +
      webp: {
          effort: number;
      }
      +
        +
      • +
        effort: number
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Image._Map.html b/Documentation/Variable/Image._Map.html new file mode 100644 index 00000000..d7b4918e --- /dev/null +++ b/Documentation/Variable/Image._Map.html @@ -0,0 +1,77 @@ +_Map | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable _Map

    +
    _Map: {
        apng: string;
        avci: string;
        avcs: string;
        avifs: string;
        heic: string;
        heics: string;
        heifs: string;
        jfif: string;
        jif: string;
        jpe: string;
        jpg: string;
    }
    +
    +

    Type declaration

    +
      +
    • +
      apng: string
    • +
    • +
      avci: string
    • +
    • +
      avcs: string
    • +
    • +
      avifs: string
    • +
    • +
      heic: string
    • +
    • +
      heics: string
    • +
    • +
      heifs: string
    • +
    • +
      jfif: string
    • +
    • +
      jif: string
    • +
    • +
      jpe: string
    • +
    • +
      jpg: string
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Integration.Default.html b/Documentation/Variable/Integration.Default.html new file mode 100644 index 00000000..fac5d5a5 --- /dev/null +++ b/Documentation/Variable/Integration.Default.html @@ -0,0 +1,52 @@ +Default | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable Default

    +
    Default: Omit<DeepMergeRecordsDefaultHKTInternalProps<[{
        Action: {
            Accomplished: ((__namedParameters) => Promise<string>);
            Changed: ((Plan) => Promise<default>);
            Failed: ((__namedParameters) => Promise<string>);
            Fulfilled: ((__namedParameters) => Promise<string | false>);
            Passed: ((On) => Promise<true>);
            Read: ((__namedParameters) => Promise<string>);
            Wrote: ((__namedParameters) => Promise<Type>);
        };
        Cache: {
            Folder: string;
            Search: string;
        };
        Exclude: false;
        Files: string;
        Logger: 2;
        Path: string;
    }, {
        Action: {
            Accomplished: ((__namedParameters) => Promise<string>);
            Changed: ((Plan) => Promise<any>);
            Failed: ((__namedParameters) => Promise<string>);
            Passed: ((__namedParameters) => Promise<boolean>);
        };
        CSS: {
            csso: {
                comments: false;
                forceMediaMerge: true;
                restructure: false;
            };
            lightningcss: {
                minify: true;
            };
        };
        HTML: {
            html-minifier-terser: {
                caseSensitive: true;
                collapseInlineTagWhitespace: false;
                collapseWhitespace: true;
                continueOnParseError: true;
                html5: true;
                ignoreCustomComments: RegExp[];
                includeAutoGeneratedTags: true;
                keepClosingSlash: true;
                minifyCSS: true;
                minifyJS: true;
                minifyURLs: false;
                noNewlinesBeforeTagClose: true;
                preventAttributesEscaping: false;
                processConditionalComments: false;
                processScripts: string[];
                quoteCharacter: string;
                removeAttributeQuotes: true;
                removeComments: true;
                removeScriptTypeAttributes: true;
                removeStyleLinkTypeAttributes: true;
                removeTagWhitespace: false;
                sortAttributes: true;
                sortClassName: true;
                trimCustomFragments: true;
                useShortDoctype: false;
            };
        };
        Image: {
            sharp: {
                avif: {
                    chromaSubsampling: string;
                    effort: number;
                };
                gif: {
                    effort: number;
                };
                jpeg: {
                    chromaSubsampling: string;
                    mozjpeg: true;
                    optimiseScans: true;
                    overshootDeringing: true;
                    trellisQuantisation: true;
                };
                png: {
                    compressionLevel: number;
                    palette: true;
                };
                raw: {};
                tiff: {
                    compression: string;
                };
                webp: {
                    effort: number;
                };
            };
        };
        JavaScript: {
            terser: {
                ecma: 5;
                enclose: false;
                format: {
                    comments: false;
                };
                ie8: false;
                keep_classnames: false;
                keep_fnames: false;
                module: false;
                safari10: false;
                toplevel: false;
            };
        };
        Map: {
            CSS: string;
            HTML: string;
            Image: string;
            JavaScript: string;
            SVG: string;
        };
        Parser: {
            CSS: ("csso" | "lightningcss")[];
            HTML: "html-minifier-terser";
            Image: "sharp";
            JavaScript: "terser";
            SVG: "svgo";
        };
        SVG: {
            svgo: {
                js2svg: {
                    indent: number;
                    pretty: false;
                };
                multipass: true;
                plugins: "preset-default"[];
            };
        };
    }], Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>, "__proto__">
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Integration.Search.html b/Documentation/Variable/Integration.Search.html new file mode 100644 index 00000000..b3262fc0 --- /dev/null +++ b/Documentation/Variable/Integration.Search.html @@ -0,0 +1,52 @@ +Search | astro-compress - v2.1.6
    +
    + +
    +
    + +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Integration._Action.html b/Documentation/Variable/Integration._Action.html new file mode 100644 index 00000000..31012a86 --- /dev/null +++ b/Documentation/Variable/Integration._Action.html @@ -0,0 +1,52 @@ +_Action | astro-compress - v2.1.6
    +
    + +
    +
    + +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/JavaScript.JavaScript.html b/Documentation/Variable/JavaScript.JavaScript.html new file mode 100644 index 00000000..acca236e --- /dev/null +++ b/Documentation/Variable/JavaScript.JavaScript.html @@ -0,0 +1,76 @@ +JavaScript | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable JavaScript

    +
    JavaScript: {
        ecma: 5;
        enclose: false;
        format: {
            comments: false;
        };
        ie8: false;
        keep_classnames: false;
        keep_fnames: false;
        module: false;
        safari10: false;
        toplevel: false;
    }
    +
    +

    Type declaration

    +
      +
    • +
      ecma: 5
    • +
    • +
      enclose: false
    • +
    • +
      format: {
          comments: false;
      }
      +
        +
      • +
        comments: false
    • +
    • +
      ie8: false
    • +
    • +
      keep_classnames: false
    • +
    • +
      keep_fnames: false
    • +
    • +
      module: false
    • +
    • +
      safari10: false
    • +
    • +
      toplevel: false
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Map.Map.html b/Documentation/Variable/Map.Map.html new file mode 100644 index 00000000..cebde50e --- /dev/null +++ b/Documentation/Variable/Map.Map.html @@ -0,0 +1,65 @@ +Map | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable Map

    +
    Map: {
        CSS: string;
        HTML: string;
        Image: string;
        JavaScript: string;
        SVG: string;
    }
    +
    +

    Type declaration

    +
      +
    • +
      CSS: string
    • +
    • +
      HTML: string
    • +
    • +
      Image: string
    • +
    • +
      JavaScript: string
    • +
    • +
      SVG: string
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Option.Option.html b/Documentation/Variable/Option.Option.html new file mode 100644 index 00000000..d718dbae --- /dev/null +++ b/Documentation/Variable/Option.Option.html @@ -0,0 +1,52 @@ +Option | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable Option

    +
    Option: Omit<DeepMergeRecordsDefaultHKTInternalProps<[{
        Action: {
            Accomplished: ((__namedParameters) => Promise<string>);
            Changed: ((Plan) => Promise<default>);
            Failed: ((__namedParameters) => Promise<string>);
            Fulfilled: ((__namedParameters) => Promise<string | false>);
            Passed: ((On) => Promise<true>);
            Read: ((__namedParameters) => Promise<string>);
            Wrote: ((__namedParameters) => Promise<Type>);
        };
        Cache: {
            Folder: string;
            Search: string;
        };
        Exclude: false;
        Files: string;
        Logger: 2;
        Path: string;
    }, {
        Action: {
            Accomplished: ((__namedParameters) => Promise<string>);
            Changed: ((Plan) => Promise<any>);
            Failed: ((__namedParameters) => Promise<string>);
            Passed: ((__namedParameters) => Promise<boolean>);
        };
        CSS: {
            csso: {
                comments: false;
                forceMediaMerge: true;
                restructure: false;
            };
            lightningcss: {
                minify: true;
            };
        };
        HTML: {
            html-minifier-terser: {
                caseSensitive: true;
                collapseInlineTagWhitespace: false;
                collapseWhitespace: true;
                continueOnParseError: true;
                html5: true;
                ignoreCustomComments: RegExp[];
                includeAutoGeneratedTags: true;
                keepClosingSlash: true;
                minifyCSS: true;
                minifyJS: true;
                minifyURLs: false;
                noNewlinesBeforeTagClose: true;
                preventAttributesEscaping: false;
                processConditionalComments: false;
                processScripts: string[];
                quoteCharacter: string;
                removeAttributeQuotes: true;
                removeComments: true;
                removeScriptTypeAttributes: true;
                removeStyleLinkTypeAttributes: true;
                removeTagWhitespace: false;
                sortAttributes: true;
                sortClassName: true;
                trimCustomFragments: true;
                useShortDoctype: false;
            };
        };
        Image: {
            sharp: {
                avif: {
                    chromaSubsampling: string;
                    effort: number;
                };
                gif: {
                    effort: number;
                };
                jpeg: {
                    chromaSubsampling: string;
                    mozjpeg: true;
                    optimiseScans: true;
                    overshootDeringing: true;
                    trellisQuantisation: true;
                };
                png: {
                    compressionLevel: number;
                    palette: true;
                };
                raw: {};
                tiff: {
                    compression: string;
                };
                webp: {
                    effort: number;
                };
            };
        };
        JavaScript: {
            terser: {
                ecma: 5;
                enclose: false;
                format: {
                    comments: false;
                };
                ie8: false;
                keep_classnames: false;
                keep_fnames: false;
                module: false;
                safari10: false;
                toplevel: false;
            };
        };
        Map: {
            CSS: string;
            HTML: string;
            Image: string;
            JavaScript: string;
            SVG: string;
        };
        Parser: {
            CSS: ("csso" | "lightningcss")[];
            HTML: "html-minifier-terser";
            Image: "sharp";
            JavaScript: "terser";
            SVG: "svgo";
        };
        SVG: {
            svgo: {
                js2svg: {
                    indent: number;
                    pretty: false;
                };
                multipass: true;
                plugins: "preset-default"[];
            };
        };
    }], Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>, "__proto__">
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/Parser.Parser.html b/Documentation/Variable/Parser.Parser.html new file mode 100644 index 00000000..81bcbdfb --- /dev/null +++ b/Documentation/Variable/Parser.Parser.html @@ -0,0 +1,65 @@ +Parser | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable Parser

    +
    Parser: {
        CSS: ("csso" | "lightningcss")[];
        HTML: "html-minifier-terser";
        Image: "sharp";
        JavaScript: "terser";
        SVG: "svgo";
    }
    +
    +

    Type declaration

    +
      +
    • +
      CSS: ("csso" | "lightningcss")[]
    • +
    • +
      HTML: "html-minifier-terser"
    • +
    • +
      Image: "sharp"
    • +
    • +
      JavaScript: "terser"
    • +
    • +
      SVG: "svgo"
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/Variable/SVG.SVG.html b/Documentation/Variable/SVG.SVG.html new file mode 100644 index 00000000..49e0fe91 --- /dev/null +++ b/Documentation/Variable/SVG.SVG.html @@ -0,0 +1,66 @@ +SVG | astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    + +

    Variable SVG

    +
    SVG: {
        js2svg: {
            indent: number;
            pretty: false;
        };
        multipass: true;
        plugins: "preset-default"[];
    }
    +
    +

    Type declaration

    +
      +
    • +
      js2svg: {
          indent: number;
          pretty: false;
      }
      +
        +
      • +
        indent: number
      • +
      • +
        pretty: false
    • +
    • +
      multipass: true
    • +
    • +
      plugins: "preset-default"[]
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/assets/highlight.css b/Documentation/assets/highlight.css new file mode 100644 index 00000000..146cd454 --- /dev/null +++ b/Documentation/assets/highlight.css @@ -0,0 +1,92 @@ +: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: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #000000; + --dark-hl-9: #C8C8C8; + --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); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --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); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --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); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --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); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --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); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +pre, code { background: var(--code-background); } diff --git a/Documentation/assets/main.js b/Documentation/assets/main.js new file mode 100644 index 00000000..d0aa8d5f --- /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;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];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/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..4f13d398 --- /dev/null +++ b/Documentation/index.html @@ -0,0 +1,173 @@ +astro-compress - v2.1.6
    +
    + +
    +
    +
    +
    +

    astro-compress - v2.1.6

    +

    Astro
    Related


    Stars
    AstroCritters
    🦔 AstroJS GoogleChromeLabs Critters integration.
    Inline your critical CSS with Astro.


    Build
    Dependencies
    Version
    Downloads

    Stars
    AstroRome
    🏛️ AstroJS Rome tools.
    Format, lint and check your Astro website with Rome.


    Build
    Dependencies
    Version
    Downloads
    + +

    🗜️ AstroCompress

    This Astro integration brings compression utilities to +your Astro project.

    +

    CSS / HTML / JavaScript / +Image / SVG

    +
    +

    Note

    +

    AstroCompress will not compress your requests, only your statically +generated build and pre-rendered routes.

    +
    +
    +

    [!IMPORTANT]

    +

    Use AstroCompress last in your integration list for the best optimization.

    +
    +

    Installation

    There are two ways to add integrations to your project. Let's try the most +convenient option first!

    +

    astro add command

    Astro includes a CLI tool for adding first party integrations: astro add. This +command will:

    +
      +
    1. (Optionally) Install all necessary dependencies and peer dependencies
    2. +
    3. (Also optionally) Update your astro.config.* file to apply this integration
    4. +
    +

    To install AstroCompress, run the following from your project directory and +follow the prompts:

    +

    Using NPM:

    +
    npx astro add astro-compress
    +
    +

    Using Yarn:

    +
    yarn astro add astro-compress
    +
    +

    Using PNPM:

    +
    pnpx astro add astro-compress
    +
    +

    Install dependencies manually

    First, install the AstroCompress integration like so:

    +
    npm install -D -E astro-compress
    +
    +

    Then, apply this integration to your astro.config.* file using the +integrations property:

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default { integrations: [Compress()] }; +
    +

    Getting started

    The utility will now automatically compress all your CSS, HTML, SVG, JavaScript +and image files in the Astro outDir folder.

    +

    The following image file types will be compressed via sharp:

    +
      +
    • avci
    • +
    • avcs
    • +
    • avif
    • +
    • avifs
    • +
    • gif
    • +
    • heic
    • +
    • heics
    • +
    • heif
    • +
    • heifs
    • +
    • jfif
    • +
    • jif
    • +
    • jpe
    • +
    • jpeg
    • +
    • jpg
    • +
    • apng
    • +
    • png
    • +
    • raw
    • +
    • tiff
    • +
    • webp
    • +
    +

    SVG compression is supported via svgo.

    +

    Default Compression

    You can override any of the default options from the configurations of:

    + +

    or disable them entirely:

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default {
    integrations: [
    Compress({
    CSS: false,
    HTML: false,
    Image: false,
    JavaScript: false,
    SVG: false,
    }),
    ],
    }; +
    +

    Adding Multiple Paths

    You can add multiple paths to compress by specifying an array as the Path +variable.

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default {
    integrations: [
    Compress({
    Path: ["./Target", "./Build"],
    }),
    ],
    }; +
    +

    Input-Output Mapping

    You can also provide a map of paths for different input output directories.

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default {
    integrations: [
    Compress({
    Path: new Map([["./Source", "./Target"]]),
    }),
    ],
    }; +
    +

    Or an array of the two.

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default {
    integrations: [
    Compress({
    Path: [
    // Compress Target
    "./Target",
    // Compress Target one more time into a different directory
    new Map([["./Target", "./TargetCompress"]]),
    ],
    }),
    ],
    }; +
    +

    File Filtering

    You can filter files to exclude specific ones from compression. A filter can be +an array of regular expressions or a single match. You can also use functions to +match on file names:

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default {
    integrations: [
    Compress({
    Exclude: [
    "File.png",
    (File: string) =>
    File === "./Target/Favicon/Image/safari-pinned-tab.svg",
    ],
    }),
    ],
    }; +
    +

    Controlling Logging

    You can control the logging level by setting the Logger parameter. The default +value is 2, but you can set it to 0 if you don't want to see debug messages:

    +

    astro.config.ts

    +
    import Compress from "astro-compress";

    export default {
    integrations: [
    Compress({
    Logger: 0,
    }),
    ],
    }; +
    +

    Changelog

    See CHANGELOG.md for a history of changes to this integration.

    +
    +
    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file