jscrewit/api-doc/interfaces/EncodeOptions.md

Converts plain JavaScript into JSFuck code, which consists of only six different characters: ! ( ) + [ ]

[**JScrewIt**](../README.md)

***

# Interface: EncodeOptions

## Properties

### features?

> `optional` **features**: [`FeatureElementOrCompatibleArray`](../type-aliases/FeatureElementOrCompatibleArray.md)

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.
To generate shorter code, specify all features available in all target engines explicitly.

***

### 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.

<dl>

<dt><code>"call"</code></dt>
<dd>
Produces code evaluating to a call to a function whose body contains the specified input
string.
</dd>

<dt><code>"eval"</code></dt>
<dd>
Produces code evaluating to the result of invoking <code>eval</code> with the specified input
string as parameter.
</dd>

<dt><code>"express"</code></dt>
<dd>
Attempts to interpret the specified string as JavaScript code and produce functionally
equivalent JSFuck code.
Fails if the specified string cannot be expressed as JavaScript, or if no functionally
equivalent JSFuck code can be generated.
</dd>

<dt><code>"express-call"</code></dt>
<dd>
Applies the code generation process of both <code>"express"</code> and <code>"call"</code>
and returns the shortest output.
</dd>

<dt><code>"express-eval"</code> (default)</dt>
<dd>
Applies the code generation process of both <code>"express"</code> and <code>"eval"</code>
and returns the shortest output.
</dd>

<dt><code>"none"</code></dt>
<dd>
Produces JSFuck code that translates to the specified input string (except for trimmed parts
when used in conjunction with the option <code>trimCode</code>).
Unlike other methods, <code>"none"</code> does not generate executable code, but rather a
plain string.
</dd>

</dl>

***

### trimCode?

> `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.
A newline terminator in the last preserved line is also removed.

This option is especially useful to strip banner comments and trailing newline characters
which are sometimes found in minified scripts.

Using this option may produce unexpected results if the input is not well-formed JavaScript
code.

***

### wrapWith?

> `optional` **wrapWith**: [`RunAs`](../type-aliases/RunAs.md)

An alias for `runAs`.