jscrewit 2.34.0 → 2.35.0

package/lib/encode.d.ts

@@ -1,15 +1,16 @@
-import { FeatureElementOrCompatibleArray } from './feature';
+import type { FeatureElementOrCompatibleArray } from './feature';
 
 export interface EncodeOptions
 {
     /**
      * Specifies the features available in the engines that evaluate the encoded output.
      *
-     * If this parameter is unspecified, [[DEFAULT|`JScrewIt.Feature.DEFAULT`]] is assumed: this
-     * ensures maximum compatibility but also generates the largest code.
+     * If this parameter is unspecified, {@link FeatureConstructor.DEFAULT |
+     * `JScrewIt.Feature.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.
      */
-    features?: FeatureElementOrCompatibleArray;
+    features?: FeatureElementOrCompatibleArray | undefined;
 
     /**
      * This option controls the type of code generated from the given input.
@@ -59,7 +60,7 @@ export interface EncodeOptions
      *
      * </dl>
      */
-    runAs?: 'call' | 'eval' | 'express' | 'express-call' | 'express-eval' | 'none';
+    runAs?: RunAs | undefined;
 
     /**
      * If this parameter is truthy, lines in the beginning and in the end of the file containing
@@ -72,12 +73,18 @@ export interface EncodeOptions
      * Using this option may produce unexpected results if the input is not well-formed JavaScript
      * code.
      */
-    trimCode?: boolean;
+    trimCode?: boolean | undefined;
 
     /** An alias for `runAs`. */
-    wrapWith?: 'call' | 'eval' | 'express' | 'express-call' | 'express-eval' | 'none';
+    wrapWith?: RunAs | undefined;
 }
 
+/**
+ * Values of this type control the type of code generated from a given input.
+ * See {@link EncodeOptions.runAs | `EncodeOptions.runAs`} for the meaning of each possible value.
+ */
+type RunAs = 'call' | 'eval' | 'express' | 'express-call' | 'express-eval' | 'none';
+
 interface encode
 {
     /**

package/lib/feature.d.ts

@@ -1,4 +1,4 @@
-import { ElementaryFeatureName, FeatureAll, PredefinedFeatureName } from './feature-all';
+import type { ElementaryFeatureName, FeatureAll, PredefinedFeatureName } from './feature-all';
 
 export interface CustomFeature extends Feature
 {
@@ -16,8 +16,8 @@ export interface ElementaryFeature extends PredefinedFeature
  * 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 [[ALL|`JScrewIt.Feature.ALL`]], where the property name is the feature's
- * name or alias.
+ * `JScrewIt.Feature` or {@link FeatureConstructor.ALL | `JScrewIt.Feature.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.
@@ -28,10 +28,10 @@ export interface ElementaryFeature extends PredefinedFeature
  * 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]]</code> is
- * the empty feature, indicating that no elementary feature is available at all;
- * <code>[[AUTO]]</code> is the union of all elementary features available in the current
- * environment.
+ * Two of the predefined composite features are particularly important: {@link
+ * FeatureConstructor.DEFAULT | `DEFAULT`} is the empty feature, indicating that no elementary
+ * feature is available at all; {@link FeatureConstructor.AUTO | `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.
@@ -119,12 +119,13 @@ export interface FeatureConstructor extends FeatureAll
      * 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
-     * <code>[[DEFAULT]]</code>.
+     * {@link FeatureConstructor.DEFAULT | `DEFAULT`}.
      *
      * @example
      *
      * The following statements are equivalent, and will all construct a new feature object
-     * including both <code>[[ANY_DOCUMENT]]</code> and <code>[[ANY_WINDOW]]</code>.
+     * including both {@link FeatureConstructor.ANY_DOCUMENT | `ANY_DOCUMENT`} and {@link
+     * FeatureConstructor.ANY_WINDOW | `ANY_WINDOW`}.
      *
      * ```js
      * new JScrewIt.Feature("ANY_DOCUMENT", "ANY_WINDOW");
@@ -172,12 +173,13 @@ export interface FeatureConstructor extends FeatureAll
      * 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
-     * <code>[[DEFAULT]]</code>.
+     * {@link FeatureConstructor.DEFAULT | `DEFAULT`}.
      *
      * @example
      *
      * The following statements are equivalent, and will all construct a new feature object
-     * including both <code>[[ANY_DOCUMENT]]</code> and <code>[[ANY_WINDOW]]</code>.
+     * including both {@link FeatureConstructor.ANY_DOCUMENT | `ANY_DOCUMENT`} and {@link
+     * FeatureConstructor.ANY_WINDOW | `ANY_WINDOW`}.
      *
      * ```js
      * JScrewIt.Feature("ANY_DOCUMENT", "ANY_WINDOW");
@@ -253,15 +255,17 @@ export interface FeatureConstructor extends FeatureAll
      *
      * @example
      *
-     * This will create a new feature object equivalent to <code>[[NAME]]</code>.
+     * This will create a new feature object equivalent to {@link FeatureConstructor.NAME | `NAME`}.
      *
      * ```js
      * const newFeature = JScrewIt.Feature.commonOf(["ATOB", "NAME"], ["NAME", "SELF"]);
      * ```
      *
-     * This will create a new feature object equivalent to <code>[[ANY_DOCUMENT]]</code>.
-     * This is because both <code>[[HTMLDOCUMENT]]</code> and <code>[[DOCUMENT]]</code> imply
-     * <code>[[ANY_DOCUMENT]]</code>.
+     * This will create a new feature object equivalent to {@link FeatureConstructor.ANY_DOCUMENT |
+     * `ANY_DOCUMENT`}.
+     * This is because both {@link FeatureConstructor.HTMLDOCUMENT | `HTMLDOCUMENT`} and {@link
+     * FeatureConstructor.DOCUMENT | `DOCUMENT`} imply {@link FeatureConstructor.ANY_DOCUMENT |
+     * `ANY_DOCUMENT`}.
      *
      * ```js
      * const newFeature = JScrewIt.Feature.commonOf("HTMLDOCUMENT", "DOCUMENT");

package/lib/jscrewit.d.ts

@@ -1,7 +1,7 @@
 // Type definitions for JScrewIt
 
-import { encode }   from './encode';
-import { Feature }  from './feature';
+import type { encode }  from './encode';
+import type { Feature } from './feature';
 
 export * from './encode';
 export * from './feature';