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/lib/feature.d.ts CHANGED
@@ -108,11 +108,8 @@ export interface Feature
108
108
  CustomFeature;
109
109
  }
110
110
 
111
- export const Feature: FeatureConstructor;
112
-
113
111
  export interface FeatureConstructor extends FeatureAll
114
112
  {
115
-
116
113
  /**
117
114
  * Creates a new feature object from the union of the specified features.
118
115
  *
@@ -124,19 +121,19 @@ export interface FeatureConstructor extends FeatureAll
124
121
  * @example
125
122
  *
126
123
  * The following statements are equivalent, and will all construct a new feature object
127
- * including both {@link FeatureConstructor.ANY_DOCUMENT | `ANY_DOCUMENT`} and {@link
128
- * FeatureConstructor.ANY_WINDOW | `ANY_WINDOW`}.
124
+ * including both {@link FeatureConstructor.DOCUMENT | `DOCUMENT`} and {@link
125
+ * FeatureConstructor.WINDOW | `WINDOW`}.
129
126
  *
130
127
  * ```js
131
- * new JScrewIt.Feature("ANY_DOCUMENT", "ANY_WINDOW");
128
+ * new JScrewIt.Feature("DOCUMENT", "WINDOW");
132
129
  * ```
133
130
  *
134
131
  * ```js
135
- * new JScrewIt.Feature(JScrewIt.Feature.ANY_DOCUMENT, JScrewIt.Feature.ANY_WINDOW);
132
+ * new JScrewIt.Feature(JScrewIt.Feature.DOCUMENT, JScrewIt.Feature.WINDOW);
136
133
  * ```
137
134
  *
138
135
  * ```js
139
- * new JScrewIt.Feature([JScrewIt.Feature.ANY_DOCUMENT, JScrewIt.Feature.ANY_WINDOW]);
136
+ * new JScrewIt.Feature([JScrewIt.Feature.DOCUMENT, JScrewIt.Feature.WINDOW]);
140
137
  * ```
141
138
  *
142
139
  * @throws
@@ -178,19 +175,19 @@ export interface FeatureConstructor extends FeatureAll
178
175
  * @example
179
176
  *
180
177
  * The following statements are equivalent, and will all construct a new feature object
181
- * including both {@link FeatureConstructor.ANY_DOCUMENT | `ANY_DOCUMENT`} and {@link
182
- * FeatureConstructor.ANY_WINDOW | `ANY_WINDOW`}.
178
+ * including both {@link FeatureConstructor.DOCUMENT | `DOCUMENT`} and {@link
179
+ * FeatureConstructor.WINDOW | `WINDOW`}.
183
180
  *
184
181
  * ```js
185
- * JScrewIt.Feature("ANY_DOCUMENT", "ANY_WINDOW");
182
+ * JScrewIt.Feature("DOCUMENT", "WINDOW");
186
183
  * ```
187
184
  *
188
185
  * ```js
189
- * JScrewIt.Feature(JScrewIt.Feature.ANY_DOCUMENT, JScrewIt.Feature.ANY_WINDOW);
186
+ * JScrewIt.Feature(JScrewIt.Feature.DOCUMENT, JScrewIt.Feature.WINDOW);
190
187
  * ```
191
188
  *
192
189
  * ```js
193
- * JScrewIt.Feature([JScrewIt.Feature.ANY_DOCUMENT, JScrewIt.Feature.ANY_WINDOW]);
190
+ * JScrewIt.Feature([JScrewIt.Feature.DOCUMENT, JScrewIt.Feature.WINDOW]);
194
191
  * ```
195
192
  *
196
193
  * @throws
@@ -216,7 +213,7 @@ export interface FeatureConstructor extends FeatureAll
216
213
  *
217
214
  * ```js
218
215
  * // true
219
- * JScrewIt.Feature.areCompatible(JScrewIt.Feature.DEFAULT, JScrewIt.Feature.FILL)
216
+ * JScrewIt.Feature.areCompatible(JScrewIt.Feature.DEFAULT, JScrewIt.Feature.FLAT)
220
217
  * ```
221
218
  */
222
219
  areCompatible(...features: FeatureElement[]): boolean;
@@ -255,20 +252,21 @@ export interface FeatureConstructor extends FeatureAll
255
252
  *
256
253
  * @example
257
254
  *
258
- * This will create a new feature object equivalent to {@link FeatureConstructor.NAME | `NAME`}.
255
+ * The following declaration creates a new feature object equivalent to
256
+ * {@link FeatureConstructor.NAME | `NAME`}.
259
257
  *
260
258
  * ```js
261
- * const newFeature = JScrewIt.Feature.commonOf(["ATOB", "NAME"], ["NAME", "SELF"]);
259
+ * const newFeature = JScrewIt.Feature.commonOf(["AT", "NAME"], ["NAME", "WINDOW"]);
262
260
  * ```
263
261
  *
264
- * This will create a new feature object equivalent to {@link FeatureConstructor.ANY_WINDOW |
265
- * `ANY_WINDOW`}.
266
- * This is because both {@link FeatureConstructor.DOMWINDOW | `DOMWINDOW`} and {@link
267
- * FeatureConstructor.WINDOW | `WINDOW`} imply {@link FeatureConstructor.ANY_WINDOW |
268
- * `ANY_WINDOW`}.
262
+ * The following declaration creates a new feature object equivalent to {@link
263
+ * FeatureConstructor.NO_IE_SRC | `NO_IE_SRC`}.
264
+ * This is because both {@link FeatureConstructor.FF_SRC | `FF_SRC`} and {@link
265
+ * FeatureConstructor.V8_SRC | `V8_SRC`} imply {@link
266
+ * FeatureConstructor.NO_IE_SRC | `NO_IE_SRC`}.
269
267
  *
270
268
  * ```js
271
- * const newFeature = JScrewIt.Feature.commonOf("DOMWINDOW", "WINDOW");
269
+ * const newFeature = JScrewIt.Feature.commonOf("FF_SRC", "V8_SRC");
272
270
  * ```
273
271
  */
274
272
  commonOf(...features: FeatureElementOrCompatibleArray[]): CustomFeature | null;
package/lib/jscrewit.d.ts CHANGED
@@ -1,16 +1,16 @@
1
1
  // Type definitions for JScrewIt
2
2
 
3
- import type { encode } from './encode';
4
- import type { Feature } from './feature';
3
+ import type { EncodeInterface } from './encode';
4
+ import type { FeatureConstructor } from './feature';
5
5
 
6
- export * from './encode';
7
- export * from './feature';
6
+ export type * from './encode';
7
+ export type * from './feature';
8
8
  export type * from './feature-all';
9
9
 
10
10
  interface JScrewIt
11
11
  {
12
- Feature: typeof Feature;
13
- encode: typeof encode;
12
+ Feature: FeatureConstructor;
13
+ encode: EncodeInterface;
14
14
  }
15
15
 
16
16
  declare global