jscrewit 2.34.0 → 2.35.0

package/api-doc/README.md

@@ -14,20 +14,24 @@
 - [default](interfaces/default.md)
 - [encode](interfaces/encode.md)
 
-### Type aliases
+### Type Aliases
 
 - [ElementaryFeatureName](README.md#elementaryfeaturename)
 - [FeatureElement](README.md#featureelement)
 - [FeatureElementOrCompatibleArray](README.md#featureelementorcompatiblearray)
 - [PredefinedFeatureName](README.md#predefinedfeaturename)
+- [RunAs](README.md#runas)
 
 ### Variables
 
-- [Feature](README.md#feature)
 - [default](README.md#default)
+
+### Functions
+
+- [Feature](README.md#feature)
 - [encode](README.md#encode)
 
-## Type aliases
+## Type Aliases
 
 ### ElementaryFeatureName
 
@@ -43,7 +47,7 @@ ___
 
 A feature object or a name or alias of a predefined feature.
 
-**`remarks`**
+**`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.
@@ -57,7 +61,7 @@ ___
 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`**
+**`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
@@ -71,22 +75,92 @@ ___
 
 Name of a predefined feature.
 
-## Variables
+___
 
-### Feature
+### RunAs
 
-• **Feature**: [`FeatureConstructor`](interfaces/FeatureConstructor.md)
+Ƭ **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.
+
+## Variables
 
 ### default
 
 • **default**: [`default`](README.md#default)
 
-JScrewIt object, available in Node.js.
+## Functions
+
+### Feature
+
+▸ **Feature**(`...features`): [`CustomFeature`](interfaces/CustomFeature.md)
+
+Creates a new feature object from the union of the specified features.
+
+The constructor can be used with or without the `new` operator, e.g.
+`new JScrewIt.Feature(feature1, feature2)` or `JScrewIt.Feature(feature1, feature2)`.
+If no arguments are specified, the new feature object will be equivalent to
+[`DEFAULT`](interfaces/FeatureConstructor.md#default).
+
+**`Example`**
+
+The following statements are equivalent, and will all construct a new feature object
+including both [`ANY_DOCUMENT`](interfaces/FeatureConstructor.md#any_document) and [`ANY_WINDOW`](interfaces/FeatureConstructor.md#any_window).
+
+```js
+new JScrewIt.Feature("ANY_DOCUMENT", "ANY_WINDOW");
+```
+
+```js
+new JScrewIt.Feature(JScrewIt.Feature.ANY_DOCUMENT, JScrewIt.Feature.ANY_WINDOW);
+```
+
+```js
+new JScrewIt.Feature([JScrewIt.Feature.ANY_DOCUMENT, JScrewIt.Feature.ANY_WINDOW]);
+```
+
+**`Throws`**
+
+An error is thrown if any of the specified features are not mutually compatible.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `...features` | [`FeatureElementOrCompatibleArray`](README.md#featureelementorcompatiblearray)[] |
+
+#### Returns
+
+[`CustomFeature`](interfaces/CustomFeature.md)
 
 ___
 
 ### encode
 
-• **encode**: [`encode`](README.md#encode)
+▸ **encode**(`input`, `options?`): `string`
+
+Encodes a given string into JSFuck.
+
+**`Throws`**
+
+An `Error` is thrown under the following circumstances.
+ - The specified string cannot be encoded with the specified options.
+ - Some unknown features were specified.
+ - A combination of mutually incompatible features was specified.
+ - The option `runAs` (or `wrapWith`) was specified with an invalid value.
+
+Also, an out of memory condition may occur when processing very large data.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `input` | `string` | The string to encode. |
+| `options?` | [`EncodeOptions`](interfaces/EncodeOptions.md) | An optional object specifying encoding options. |
+
+#### Returns
+
+`string`
+
+The encoded string.

package/api-doc/interfaces/CustomFeature.md

@@ -74,7 +74,7 @@ Feature.name
 
 ### includes
 
-▸ **includes**(...`features`): `boolean`
+▸ **includes**(`...features`): `boolean`
 
 Determines whether this feature object includes all of the specified features.
 
@@ -111,7 +111,7 @@ that require strict mode code, or inside web workers.
 
 | 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> |
+| `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

package/api-doc/interfaces/ElementaryFeature.md

@@ -71,7 +71,7 @@ ___
 
 ### includes
 
-▸ **includes**(...`features`): `boolean`
+▸ **includes**(`...features`): `boolean`
 
 Determines whether this feature object includes all of the specified features.
 
@@ -108,7 +108,7 @@ that require strict mode code, or inside web workers.
 
 | 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> |
+| `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

package/api-doc/interfaces/EncodeOptions.md

@@ -17,15 +17,15 @@
 
 Specifies the features available in the engines that evaluate the encoded output.
 
-If this parameter is unspecified, [`JScrewIt.Feature.DEFAULT`](FeatureConstructor.md#default) is assumed: this
-ensures maximum compatibility but also generates the largest code.
+If this parameter is unspecified, [`JScrewIt.Feature.DEFAULT`](FeatureConstructor.md#default) is assumed: this ensures maximum compatibility but also generates
+the largest code.
 To generate shorter code, specify all features available in all target engines explicitly.
 
 ___
 
 ### runAs
 
-• `Optional` **runAs**: ``"call"`` \| ``"eval"`` \| ``"express"`` \| ``"express-call"`` \| ``"express-eval"`` \| ``"none"``
+• `Optional` **runAs**: [`RunAs`](../README.md#runas)
 
 This option controls the type of code generated from the given input.
 Allowed values are listed below.
@@ -94,6 +94,6 @@ ___
 
 ### wrapWith
 
-• `Optional` **wrapWith**: ``"call"`` \| ``"eval"`` \| ``"express"`` \| ``"express-call"`` \| ``"express-eval"`` \| ``"none"``
+• `Optional` **wrapWith**: [`RunAs`](../README.md#runas)
 
 An alias for `runAs`.

package/api-doc/interfaces/Feature.md

@@ -4,8 +4,8 @@ Objects of this type indicate which of the capabilities that JScrewIt can use to
 length of its output are available in a particular JavaScript engine.
 
 JScrewIt comes with a set of predefined feature objects exposed as property values of
-`JScrewIt.Feature` or [`JScrewIt.Feature.ALL`](FeatureConstructor.md#all), where the property name is the feature's
-name or alias.
+`JScrewIt.Feature` or [`JScrewIt.Feature.ALL`](FeatureConstructor.md#all), where the property
+name is the feature's name or alias.
 
 Besides these predefined features, it is possible to construct custom features from the union or
 intersection of other features.
@@ -16,10 +16,9 @@ they are different from such a union in that they exclude some other feature not
 their elementary components.
 All other features, called *composite* features, can be constructed as a union of zero or more
 elementary features.
-Two of the predefined composite features are particularly important: <code>[DEFAULT](FeatureConstructor.md#default)</code> is
-the empty feature, indicating that no elementary feature is available at all;
-<code>[AUTO](FeatureConstructor.md#auto)</code> is the union of all elementary features available in the current
-environment.
+Two of the predefined composite features are particularly important: [`DEFAULT`](FeatureConstructor.md#default) is the empty feature, indicating that no elementary
+feature is available at all; [`AUTO`](FeatureConstructor.md#auto) is the union of all
+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.
@@ -78,7 +77,7 @@ If a name is assigned, it will be used when the feature is converted into a stri
 
 ### includes
 
-▸ **includes**(...`features`): `boolean`
+▸ **includes**(`...features`): `boolean`
 
 Determines whether this feature object includes all of the specified features.
 
@@ -111,7 +110,7 @@ that require strict mode code, or inside web workers.
 
 | 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> |
+| `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