jscrewit 2.37.0 → 2.38.0

package/api-doc/interfaces/ElementaryFeature.md

@@ -1,3 +1,7 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
 # Interface: ElementaryFeature
 
 Objects of this type indicate which of the capabilities that JScrewIt can use to minimize the
@@ -23,68 +27,52 @@ elementary features available in the current environment.
 Not all features can be available at the same time: some features are necessarily incompatible,
 meaning that they mutually exclude each other, and thus their union cannot be constructed.
 
-## Hierarchy
+## Extends
 
 - [`PredefinedFeature`](PredefinedFeature.md)
 
-  ↳ **`ElementaryFeature`**
-
-## Table of contents
-
-### Properties
-
-- [canonicalNames](ElementaryFeature.md#canonicalnames)
-- [elementary](ElementaryFeature.md#elementary)
-- [elementaryNames](ElementaryFeature.md#elementarynames)
-- [name](ElementaryFeature.md#name)
-
-### Methods
-
-- [includes](ElementaryFeature.md#includes)
-- [restrict](ElementaryFeature.md#restrict)
-
 ## Properties
 
 ### canonicalNames
 
-• `Readonly` **canonicalNames**: [`ElementaryFeatureName`](../README.md#elementaryfeaturename)[]
+> `readonly` **canonicalNames**: [`ElementaryFeatureName`](../type-aliases/ElementaryFeatureName.md)[]
 
 An array of all elementary feature names included in this feature object, without aliases and
 implied features.
 
 #### Inherited from
 
-[PredefinedFeature](PredefinedFeature.md).[canonicalNames](PredefinedFeature.md#canonicalnames)
+[`PredefinedFeature`](PredefinedFeature.md).[`canonicalNames`](PredefinedFeature.md#canonicalnames)
 
-___
+***
 
 ### elementary
 
-• `Readonly` **elementary**: ``true``
+> `readonly` **elementary**: `true`
 
 A boolean value indicating whether this is an elementary feature object.
 
 #### Overrides
 
-[PredefinedFeature](PredefinedFeature.md).[elementary](PredefinedFeature.md#elementary)
+[`PredefinedFeature`](PredefinedFeature.md).[`elementary`](PredefinedFeature.md#elementary)
 
-___
+***
 
 ### elementaryNames
 
-• `Readonly` **elementaryNames**: [`ElementaryFeatureName`](../README.md#elementaryfeaturename)[]
+> `readonly` **elementaryNames**: [`ElementaryFeatureName`](../type-aliases/ElementaryFeatureName.md)[]
 
 An array of all elementary feature names included in this feature object, without aliases.
 
 #### Inherited from
 
-[PredefinedFeature](PredefinedFeature.md).[elementaryNames](PredefinedFeature.md#elementarynames)
+[`PredefinedFeature`](PredefinedFeature.md).[`elementaryNames`](PredefinedFeature.md#elementarynames)
 
-___
+***
 
 ### name
 
-• `Readonly` **name**: [`ElementaryFeatureName`](../README.md#elementaryfeaturename)
+> `readonly` **name**: [`ElementaryFeatureName`](../type-aliases/ElementaryFeatureName.md)
 
 The primary name of this feature object, useful for identification purpose.
 
@@ -93,21 +81,19 @@ If a name is assigned, it will be used when the feature is converted into a stri
 
 #### Overrides
 
-[PredefinedFeature](PredefinedFeature.md).[name](PredefinedFeature.md#name)
+[`PredefinedFeature`](PredefinedFeature.md).[`name`](PredefinedFeature.md#name)
 
 ## Methods
 
-### includes
+### includes()
 
-▸ **includes**(`...features`): `boolean`
+> **includes**(...`features`): `boolean`
 
 Determines whether this feature object includes all of the specified features.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `...features` | [`FeatureElementOrCompatibleArray`](../README.md#featureelementorcompatiblearray)[] |
+• ...**features**: [`FeatureElementOrCompatibleArray`](../type-aliases/FeatureElementOrCompatibleArray.md)[]
 
 #### Returns
 
@@ -118,13 +104,13 @@ If no arguments are specified, the return value is `true`.
 
 #### Inherited from
 
-[PredefinedFeature](PredefinedFeature.md).[includes](PredefinedFeature.md#includes)
+[`PredefinedFeature`](PredefinedFeature.md).[`includes`](PredefinedFeature.md#includes)
 
-___
+***
 
-### restrict
+### restrict()
 
-▸ **restrict**(`environment`, `engineFeatureObjs?`): [`CustomFeature`](CustomFeature.md)
+> **restrict**(`environment`, `engineFeatureObjs`?): [`CustomFeature`](CustomFeature.md)
 
 Creates a new feature object from this feature by removing elementary features that are not
 available inside a particular environment.
@@ -134,10 +120,28 @@ that require strict mode code, or inside web workers.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `environment` | ``"forced-strict-mode"`` \| ``"web-worker"`` | The environment to which this feature should be restricted. Two environments are currently supported. <dl> <dt><code>"forced-strict-mode"</code></dt> <dd> Removes features that are not available in environments that require strict mode code. </dd> <dt><code>"web-worker"</code></dt> <dd>Removes features that are not available inside web workers.</dd> </dl> |
-| `engineFeatureObjs?` | readonly [`PredefinedFeature`](PredefinedFeature.md)[] | An array of predefined feature objects, each corresponding to a particular engine in which the restriction should be enacted. If this parameter is omitted, the restriction is enacted in all engines. |
+• **environment**: `"forced-strict-mode"` \| `"web-worker"`
+
+The environment to which this feature should be restricted.
+Two environments are currently supported.
+
+<dl>
+
+<dt><code>"forced-strict-mode"</code></dt>
+<dd>
+Removes features that are not available in environments that require strict mode code.
+</dd>
+
+<dt><code>"web-worker"</code></dt>
+<dd>Removes features that are not available inside web workers.</dd>
+
+</dl>
+
+• **engineFeatureObjs?**: readonly [`PredefinedFeature`](PredefinedFeature.md)[]
+
+An array of predefined feature objects, each corresponding to a particular engine in which
+the restriction should be enacted.
+If this parameter is omitted, the restriction is enacted in all engines.
 
 #### Returns
 
@@ -145,4 +149,4 @@ that require strict mode code, or inside web workers.
 
 #### Inherited from
 
-[PredefinedFeature](PredefinedFeature.md).[restrict](PredefinedFeature.md#restrict)
+[`PredefinedFeature`](PredefinedFeature.md).[`restrict`](PredefinedFeature.md#restrict)

package/api-doc/interfaces/EncodeOptions.md

@@ -1,19 +1,14 @@
-# Interface: EncodeOptions
-
-## Table of contents
+[**JScrewIt**](../README.md) • **Docs**
 
-### Properties
+***
 
-- [features](EncodeOptions.md#features)
-- [runAs](EncodeOptions.md#runas)
-- [trimCode](EncodeOptions.md#trimcode)
-- [wrapWith](EncodeOptions.md#wrapwith)
+# Interface: EncodeOptions
 
 ## Properties
 
-### features
+### features?
 
-• `Optional` **features**: [`FeatureElementOrCompatibleArray`](../README.md#featureelementorcompatiblearray)
+> `optional` **features**: [`FeatureElementOrCompatibleArray`](../type-aliases/FeatureElementOrCompatibleArray.md)
 
 Specifies the features available in the engines that evaluate the encoded output.
 
@@ -21,11 +16,11 @@ If this parameter is unspecified, [`JScrewIt.Feature.DEFAULT`](FeatureConstructo
 the largest code.
 To generate shorter code, specify all features available in all target engines explicitly.
 
-___
+***
 
-### runAs
+### runAs?
 
-• `Optional` **runAs**: [`RunAs`](../README.md#runas)
+> `optional` **runAs**: [`RunAs`](../type-aliases/RunAs.md)
 
 This option controls the type of code generated from the given input.
 Allowed values are listed below.
@@ -74,11 +69,11 @@ plain string.
 
 </dl>
 
-___
+***
 
-### trimCode
+### trimCode?
 
-• `Optional` **trimCode**: `boolean`
+> `optional` **trimCode**: `boolean`
 
 If this parameter is truthy, lines in the beginning and in the end of the file containing
 nothing but space characters and JavaScript comments are removed from the generated output.
@@ -90,10 +85,10 @@ which are sometimes found in minified scripts.
 Using this option may produce unexpected results if the input is not well-formed JavaScript
 code.
 
-___
+***
 
-### wrapWith
+### wrapWith?
 
-• `Optional` **wrapWith**: [`RunAs`](../README.md#runas)
+> `optional` **wrapWith**: [`RunAs`](../type-aliases/RunAs.md)
 
 An alias for `runAs`.

package/api-doc/interfaces/Feature.md

@@ -1,3 +1,7 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
 # Interface: Feature
 
 Objects of this type indicate which of the capabilities that JScrewIt can use to minimize the
@@ -23,58 +27,41 @@ elementary features available in the current environment.
 Not all features can be available at the same time: some features are necessarily incompatible,
 meaning that they mutually exclude each other, and thus their union cannot be constructed.
 
-## Hierarchy
-
-- **`Feature`**
-
-  ↳ [`CustomFeature`](CustomFeature.md)
-
-  ↳ [`PredefinedFeature`](PredefinedFeature.md)
-
-## Table of contents
-
-### Properties
-
-- [canonicalNames](Feature.md#canonicalnames)
-- [elementary](Feature.md#elementary)
-- [elementaryNames](Feature.md#elementarynames)
-- [name](Feature.md#name)
+## Extended by
 
-### Methods
-
-- [includes](Feature.md#includes)
-- [restrict](Feature.md#restrict)
+- [`CustomFeature`](CustomFeature.md)
+- [`PredefinedFeature`](PredefinedFeature.md)
 
 ## Properties
 
 ### canonicalNames
 
-• `Readonly` **canonicalNames**: [`ElementaryFeatureName`](../README.md#elementaryfeaturename)[]
+> `readonly` **canonicalNames**: [`ElementaryFeatureName`](../type-aliases/ElementaryFeatureName.md)[]
 
 An array of all elementary feature names included in this feature object, without aliases and
 implied features.
 
-___
+***
 
 ### elementary
 
-• `Readonly` **elementary**: `boolean`
+> `readonly` **elementary**: `boolean`
 
 A boolean value indicating whether this is an elementary feature object.
 
-___
+***
 
 ### elementaryNames
 
-• `Readonly` **elementaryNames**: [`ElementaryFeatureName`](../README.md#elementaryfeaturename)[]
+> `readonly` **elementaryNames**: [`ElementaryFeatureName`](../type-aliases/ElementaryFeatureName.md)[]
 
 An array of all elementary feature names included in this feature object, without aliases.
 
-___
+***
 
-### name
+### name?
 
-• `Optional` **name**: `string`
+> `optional` **name**: `string`
 
 The primary name of this feature object, useful for identification purpose.
 
@@ -83,17 +70,15 @@ If a name is assigned, it will be used when the feature is converted into a stri
 
 ## Methods
 
-### includes
+### includes()
 
-▸ **includes**(`...features`): `boolean`
+> **includes**(...`features`): `boolean`
 
 Determines whether this feature object includes all of the specified features.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `...features` | [`FeatureElementOrCompatibleArray`](../README.md#featureelementorcompatiblearray)[] |
+• ...**features**: [`FeatureElementOrCompatibleArray`](../type-aliases/FeatureElementOrCompatibleArray.md)[]
 
 #### Returns
 
@@ -102,11 +87,11 @@ Determines whether this feature object includes all of the specified features.
 `true` if this feature object includes all of the specified features; otherwise, `false`.
 If no arguments are specified, the return value is `true`.
 
-___
+***
 
-### restrict
+### restrict()
 
-▸ **restrict**(`environment`, `engineFeatureObjs?`): [`CustomFeature`](CustomFeature.md)
+> **restrict**(`environment`, `engineFeatureObjs`?): [`CustomFeature`](CustomFeature.md)
 
 Creates a new feature object from this feature by removing elementary features that are not
 available inside a particular environment.
@@ -116,10 +101,28 @@ that require strict mode code, or inside web workers.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `environment` | ``"forced-strict-mode"`` \| ``"web-worker"`` | The environment to which this feature should be restricted. Two environments are currently supported. <dl> <dt><code>"forced-strict-mode"</code></dt> <dd> Removes features that are not available in environments that require strict mode code. </dd> <dt><code>"web-worker"</code></dt> <dd>Removes features that are not available inside web workers.</dd> </dl> |
-| `engineFeatureObjs?` | readonly [`PredefinedFeature`](PredefinedFeature.md)[] | An array of predefined feature objects, each corresponding to a particular engine in which the restriction should be enacted. If this parameter is omitted, the restriction is enacted in all engines. |
+• **environment**: `"forced-strict-mode"` \| `"web-worker"`
+
+The environment to which this feature should be restricted.
+Two environments are currently supported.
+
+<dl>
+
+<dt><code>"forced-strict-mode"</code></dt>
+<dd>
+Removes features that are not available in environments that require strict mode code.
+</dd>
+
+<dt><code>"web-worker"</code></dt>
+<dd>Removes features that are not available inside web workers.</dd>
+
+</dl>
+
+• **engineFeatureObjs?**: readonly [`PredefinedFeature`](PredefinedFeature.md)[]
+
+An array of predefined feature objects, each corresponding to a particular engine in which
+the restriction should be enacted.
+If this parameter is omitted, the restriction is enacted in all engines.
 
 #### Returns