jscrewit 2.41.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api-doc/README.md CHANGED
@@ -4,12 +4,16 @@
4
4
 
5
5
  # JScrewIt
6
6
 
7
+ ## Namespaces
8
+
9
+ - [EncodeOptions](JScrewIt/namespaces/EncodeOptions/README.md)
10
+
7
11
  ## Interfaces
8
12
 
9
13
  - [CustomFeature](interfaces/CustomFeature.md)
10
14
  - [default](interfaces/default.md)
11
15
  - [ElementaryFeature](interfaces/ElementaryFeature.md)
12
- - [encode](interfaces/encode.md)
16
+ - [EncodeInterface](interfaces/EncodeInterface.md)
13
17
  - [EncodeOptions](interfaces/EncodeOptions.md)
14
18
  - [Feature](interfaces/Feature.md)
15
19
  - [FeatureAll](interfaces/FeatureAll.md)
@@ -22,10 +26,7 @@
22
26
  - [FeatureElement](type-aliases/FeatureElement.md)
23
27
  - [FeatureElementOrCompatibleArray](type-aliases/FeatureElementOrCompatibleArray.md)
24
28
  - [PredefinedFeatureName](type-aliases/PredefinedFeatureName.md)
25
- - [RunAs](type-aliases/RunAs.md)
26
29
 
27
30
  ## Variables
28
31
 
29
32
  - [default](variables/default.md)
30
- - [encode](variables/encode.md)
31
- - [Feature](variables/Feature.md)
@@ -72,7 +72,7 @@ An array of all elementary feature names included in this feature object, withou
72
72
 
73
73
  ### name?
74
74
 
75
- > `optional` **name**: `string`
75
+ > `optional` **name?**: `string`
76
76
 
77
77
  The primary name of this feature object, useful for identification purpose.
78
78
 
@@ -124,6 +124,8 @@ that require strict mode code, or inside web workers.
124
124
 
125
125
  ##### environment
126
126
 
127
+ `"forced-strict-mode"` \| `"web-worker"`
128
+
127
129
  The environment to which this feature should be restricted.
128
130
  Two environments are currently supported.
129
131
 
@@ -139,8 +141,6 @@ Removes features that are not available in environments that require strict mode
139
141
 
140
142
  </dl>
141
143
 
142
- `"forced-strict-mode"` | `"web-worker"`
143
-
144
144
  ##### engineFeatureObjs?
145
145
 
146
146
  readonly [`PredefinedFeature`](PredefinedFeature.md)[]
@@ -124,6 +124,8 @@ that require strict mode code, or inside web workers.
124
124
 
125
125
  ##### environment
126
126
 
127
+ `"forced-strict-mode"` \| `"web-worker"`
128
+
127
129
  The environment to which this feature should be restricted.
128
130
  Two environments are currently supported.
129
131
 
@@ -139,8 +141,6 @@ Removes features that are not available in environments that require strict mode
139
141
 
140
142
  </dl>
141
143
 
142
- `"forced-strict-mode"` | `"web-worker"`
143
-
144
144
  ##### engineFeatureObjs?
145
145
 
146
146
  readonly [`PredefinedFeature`](PredefinedFeature.md)[]
@@ -2,9 +2,9 @@
2
2
 
3
3
  ***
4
4
 
5
- # Interface: encode()
5
+ # Interface: EncodeInterface()
6
6
 
7
- > **encode**(`input`, `options?`): `string`
7
+ > **EncodeInterface**(`input`, `options?`): `string`
8
8
 
9
9
  Encodes a given string into JSFuck.
10
10
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ### features?
10
10
 
11
- > `optional` **features**: [`FeatureElementOrCompatibleArray`](../type-aliases/FeatureElementOrCompatibleArray.md)
11
+ > `optional` **features?**: [`FeatureElementOrCompatibleArray`](../type-aliases/FeatureElementOrCompatibleArray.md)
12
12
 
13
13
  Specifies the features available in the engines that evaluate the encoded output.
14
14
 
@@ -20,7 +20,7 @@ To generate shorter code, specify all features available in all target engines e
20
20
 
21
21
  ### runAs?
22
22
 
23
- > `optional` **runAs**: [`RunAs`](../type-aliases/RunAs.md)
23
+ > `optional` **runAs?**: [`RunAs`](../JScrewIt/namespaces/EncodeOptions/type-aliases/RunAs.md)
24
24
 
25
25
  This option controls the type of code generated from the given input.
26
26
  Allowed values are listed below.
@@ -73,7 +73,7 @@ plain string.
73
73
 
74
74
  ### trimCode?
75
75
 
76
- > `optional` **trimCode**: `boolean`
76
+ > `optional` **trimCode?**: `boolean`
77
77
 
78
78
  If this parameter is truthy, lines in the beginning and in the end of the file containing
79
79
  nothing but space characters and JavaScript comments are removed from the generated output.
@@ -89,6 +89,6 @@ code.
89
89
 
90
90
  ### wrapWith?
91
91
 
92
- > `optional` **wrapWith**: [`RunAs`](../type-aliases/RunAs.md)
92
+ > `optional` **wrapWith?**: [`RunAs`](../JScrewIt/namespaces/EncodeOptions/type-aliases/RunAs.md)
93
93
 
94
94
  An alias for `runAs`.
@@ -61,7 +61,7 @@ An array of all elementary feature names included in this feature object, withou
61
61
 
62
62
  ### name?
63
63
 
64
- > `optional` **name**: `string`
64
+ > `optional` **name?**: `string`
65
65
 
66
66
  The primary name of this feature object, useful for identification purpose.
67
67
 
@@ -105,6 +105,8 @@ that require strict mode code, or inside web workers.
105
105
 
106
106
  ##### environment
107
107
 
108
+ `"forced-strict-mode"` \| `"web-worker"`
109
+
108
110
  The environment to which this feature should be restricted.
109
111
  Two environments are currently supported.
110
112
 
@@ -120,8 +122,6 @@ Removes features that are not available in environments that require strict mode
120
122
 
121
123
  </dl>
122
124
 
123
- `"forced-strict-mode"` | `"web-worker"`
124
-
125
125
  ##### engineFeatureObjs?
126
126
 
127
127
  readonly [`PredefinedFeature`](PredefinedFeature.md)[]