jscrewit 2.37.0 → 2.39.0

package/api-doc/interfaces/PredefinedFeature.md

@@ -1,3 +1,7 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
 # Interface: PredefinedFeature
 
 Objects of this type indicate which of the capabilities that JScrewIt can use to minimize the
@@ -23,70 +27,56 @@ 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
 
 - [`Feature`](Feature.md)
 
-  ↳ **`PredefinedFeature`**
-
-  ↳↳ [`ElementaryFeature`](ElementaryFeature.md)
-
-## Table of contents
-
-### Properties
-
-- [canonicalNames](PredefinedFeature.md#canonicalnames)
-- [elementary](PredefinedFeature.md#elementary)
-- [elementaryNames](PredefinedFeature.md#elementarynames)
-- [name](PredefinedFeature.md#name)
-
-### Methods
+## Extended by
 
-- [includes](PredefinedFeature.md#includes)
-- [restrict](PredefinedFeature.md#restrict)
+- [`ElementaryFeature`](ElementaryFeature.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.
 
 #### Inherited from
 
-[Feature](Feature.md).[canonicalNames](Feature.md#canonicalnames)
+[`Feature`](Feature.md).[`canonicalNames`](Feature.md#canonicalnames)
 
-___
+***
 
 ### elementary
 
-• `Readonly` **elementary**: `boolean`
+> `readonly` **elementary**: `boolean`
 
 A boolean value indicating whether this is an elementary feature object.
 
 #### Inherited from
 
-[Feature](Feature.md).[elementary](Feature.md#elementary)
+[`Feature`](Feature.md).[`elementary`](Feature.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
 
-[Feature](Feature.md).[elementaryNames](Feature.md#elementarynames)
+[`Feature`](Feature.md).[`elementaryNames`](Feature.md#elementarynames)
 
-___
+***
 
 ### name
 
-• `Readonly` **name**: [`PredefinedFeatureName`](../README.md#predefinedfeaturename)
+> `readonly` **name**: [`PredefinedFeatureName`](../type-aliases/PredefinedFeatureName.md)
 
 The primary name of this feature object, useful for identification purpose.
 
@@ -95,21 +85,19 @@ If a name is assigned, it will be used when the feature is converted into a stri
 
 #### Overrides
 
-[Feature](Feature.md).[name](Feature.md#name)
+[`Feature`](Feature.md).[`name`](Feature.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
 
@@ -120,13 +108,13 @@ If no arguments are specified, the return value is `true`.
 
 #### Inherited from
 
-[Feature](Feature.md).[includes](Feature.md#includes)
+[`Feature`](Feature.md).[`includes`](Feature.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.
@@ -136,10 +124,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
 
@@ -147,4 +153,4 @@ that require strict mode code, or inside web workers.
 
 #### Inherited from
 
-[Feature](Feature.md).[restrict](Feature.md#restrict)
+[`Feature`](Feature.md).[`restrict`](Feature.md#restrict)

package/api-doc/interfaces/default.md

@@ -1,20 +1,17 @@
-# Interface: default
-
-## Table of contents
+[**JScrewIt**](../README.md) • **Docs**
 
-### Properties
+***
 
-- [Feature](default.md#feature)
-- [encode](default.md#encode)
+# Interface: default
 
 ## Properties
 
-### Feature
+### encode
 
-• **Feature**: [`FeatureConstructor`](FeatureConstructor.md)
+> **encode**: [`encode`](encode.md)
 
-___
+***
 
-### encode
+### Feature
 
-• **encode**: [`encode`](encode.md)
+> **Feature**: [`FeatureConstructor`](FeatureConstructor.md)

package/api-doc/interfaces/encode.md

@@ -1,27 +1,30 @@
-# Interface: encode
+[**JScrewIt**](../README.md) • **Docs**
 
-## Callable
+***
 
-### encode
+# Interface: encode()
 
-▸ **encode**(`input`, `options?`): `string`
+> **encode**(`input`, `options`?): `string`
 
 Encodes a given string into JSFuck.
 
-#### Parameters
+## Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `input` | `string` | The string to encode. |
-| `options?` | [`EncodeOptions`](EncodeOptions.md) | An optional object specifying encoding options. |
+• **input**: `string`
 
-#### Returns
+The string to encode.
+
+• **options?**: [`EncodeOptions`](EncodeOptions.md)
+
+An optional object specifying encoding options.
+
+## Returns
 
 `string`
 
 The encoded string.
 
-**`Throws`**
+## Throws
 
 An `Error` is thrown under the following circumstances.
  - The specified string cannot be encoded with the specified options.
@@ -31,17 +34,11 @@ An `Error` is thrown under the following circumstances.
 
 Also, an out of memory condition may occur when processing very large data.
 
-## Table of contents
-
-### Properties
-
-- [permanentCaching](encode.md#permanentcaching)
-
 ## Properties
 
 ### permanentCaching
 
-• **permanentCaching**: `boolean`
+> **permanentCaching**: `boolean`
 
 Determines whether all created encoders are cached permanently.
 

package/api-doc/type-aliases/ElementaryFeatureName.md

@@ -0,0 +1,9 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Type Alias: ElementaryFeatureName
+
+> **ElementaryFeatureName**: `"ANY_DOCUMENT"` \| `"ANY_WINDOW"` \| `"ARRAY_ITERATOR"` \| `"ARROW"` \| `"ASYNC_FUNCTION"` \| `"AT"` \| `"ATOB"` \| `"BARPROP"` \| `"CALL_ON_GLOBAL"` \| `"CAPITAL_HTML"` \| `"CONSOLE"` \| `"DOCUMENT"` \| `"DOMWINDOW"` \| `"ESC_HTML_ALL"` \| `"ESC_HTML_QUOT"` \| `"ESC_HTML_QUOT_ONLY"` \| `"ESC_REGEXP_LF"` \| `"ESC_REGEXP_SLASH"` \| `"FF_SRC"` \| `"FILL"` \| `"FLAT"` \| `"FROM_CODE_POINT"` \| `"FUNCTION_19_LF"` \| `"FUNCTION_22_LF"` \| `"GENERIC_ARRAY_TO_STRING"` \| `"GLOBAL_UNDEFINED"` \| `"GMT"` \| `"HISTORY"` \| `"HTMLAUDIOELEMENT"` \| `"IE_SRC"` \| `"INCR_CHAR"` \| `"INTL"` \| `"ITERATOR_HELPER"` \| `"JAPANESE_INFINITY"` \| `"LOCALE_INFINITY"` \| `"LOCALE_NUMERALS"` \| `"LOCALE_NUMERALS_EXT"` \| `"LOCATION"` \| `"MOZILLA"` \| `"NAME"` \| `"NODECONSTRUCTOR"` \| `"NO_FF_SRC"` \| `"NO_IE_SRC"` \| `"NO_OLD_SAFARI_ARRAY_ITERATOR"` \| `"NO_V8_SRC"` \| `"OBJECT_ARRAY_ENTRIES_CTOR"` \| `"OBJECT_L_LOCATION_CTOR"` \| `"OBJECT_UNDEFINED"` \| `"OBJECT_W_SELF"` \| `"OLD_SAFARI_LOCATION_CTOR"` \| `"PLAIN_INTL"` \| `"REGEXP_STRING_ITERATOR"` \| `"SELF_OBJ"` \| `"SHORT_LOCALES"` \| `"STATUS"` \| `"UNDEFINED"` \| `"V8_SRC"` \| `"WINDOW"`
+
+Name of an elementary feature.

package/api-doc/type-aliases/FeatureElement.md

@@ -0,0 +1,14 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Type Alias: FeatureElement
+
+> **FeatureElement**: [`Feature`](../interfaces/Feature.md) \| keyof [`FeatureAll`](../interfaces/FeatureAll.md)
+
+A feature object or a name or alias of a predefined feature.
+
+## Remarks
+
+Methods that accept parameters of this type throw an error if the specified value is neither a
+feature object nor a name or alias of a predefined feature.

package/api-doc/type-aliases/FeatureElementOrCompatibleArray.md

@@ -0,0 +1,16 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Type Alias: FeatureElementOrCompatibleArray
+
+> **FeatureElementOrCompatibleArray**: [`FeatureElement`](FeatureElement.md) \| readonly [`FeatureElement`](FeatureElement.md)[]
+
+A feature object, a name or alias of a predefined feature, or an array of such values that
+defines a union of mutually compatible features.
+
+## Remarks
+
+Methods that accept parameters of this type throw an error if the specified value is neither a
+feature object nor a name or alias of a predefined feature, or if it is an array of values that
+does not define a union of mutually compatible features.

package/api-doc/type-aliases/PredefinedFeatureName.md

@@ -0,0 +1,9 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Type Alias: PredefinedFeatureName
+
+> **PredefinedFeatureName**: [`ElementaryFeatureName`](ElementaryFeatureName.md) \| `"ANDRO_4_0"` \| `"ANDRO_4_1"` \| `"ANDRO_4_4"` \| `"AUTO"` \| `"BROWSER"` \| `"CHROME_122"` \| `"COMPACT"` \| `"DEFAULT"` \| `"FF_131"` \| `"FF_90"` \| `"IE_10"` \| `"IE_11"` \| `"IE_11_WIN_10"` \| `"IE_9"` \| `"NODE_0_10"` \| `"NODE_0_12"` \| `"NODE_10"` \| `"NODE_11"` \| `"NODE_12"` \| `"NODE_13"` \| `"NODE_15"` \| `"NODE_16_0"` \| `"NODE_16_6"` \| `"NODE_22"` \| `"NODE_4"` \| `"NODE_5"` \| `"NODE_7_6"` \| `"SAFARI_10_0"` \| `"SAFARI_10_1"` \| `"SAFARI_12"` \| `"SAFARI_13"` \| `"SAFARI_14_0_1"` \| `"SAFARI_14_1"` \| `"SAFARI_15_4"` \| `"SAFARI_17_4"` \| `"SAFARI_18"` \| `"SAFARI_7_0"` \| `"SAFARI_7_1"` \| `"SAFARI_9"`
+
+Name of a predefined feature.

package/api-doc/type-aliases/RunAs.md

@@ -0,0 +1,10 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Type Alias: RunAs
+
+> **RunAs**: `"call"` \| `"eval"` \| `"express"` \| `"express-call"` \| `"express-eval"` \| `"none"`
+
+Values of this type control the type of code generated from a given input.
+See [`EncodeOptions.runAs`](../interfaces/EncodeOptions.md#runas) for the meaning of each possible value.

package/api-doc/variables/Feature.md

@@ -0,0 +1,7 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Variable: Feature
+
+> **Feature**: [`FeatureConstructor`](../interfaces/FeatureConstructor.md)

package/api-doc/variables/default.md

@@ -0,0 +1,7 @@
+[**JScrewIt**](../README.md) • **Docs**
+
+***
+
+# Variable: default
+
+> **default**: [`default`](../interfaces/default.md)